Skip to content

Update README.md #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WilliamTjonndal merged 1 commit into from
Apr 22, 2025
Merged

Update README.md #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# Chess Evolved

See below for instructions for compiling and running the project.

A [libGDX](https://libgdx.com/) project generated with [gdx-liftoff](https://github.com/libgdx/gdx-liftoff).

This project was generated with a Kotlin project template that includes Kotlin application launchers and [KTX](https://libktx.github.io/) utilities.

## Platforms

- `core`: Main module with the application logic shared by all platforms.
- `chessevolved_model`: Main module with the application logic shared by all platforms.
- `chessevolved_presenter`: Module with the application logic shared by all platforms.
- `chessevolved_shared`: Module containg DTOs and Enums used by all other modules.
- `chessevolved_view`: Module containing the logic the different views.
- `lwjgl3`: Primary desktop platform using LWJGL3; was called 'desktop' in older docs.
- `android`: Android mobile platform. Needs Android SDK.

## Setting up Supabase for production

This no longer requires to be done, as the env file is now included in the main branch.

Add a env (no dot) file to the `/assets` folder and add `SUPABASE_ANON_KEY={anon_key}` and `SUPABASE_URL={project_url}` to this file.
> You should replace "{anon_key}" and "{project_url}" with the key and url you find under Project Settings->Data API on supabase.

Expand Down