update readme

This commit is contained in:
Nathaniel Tampus
2023-01-03 16:01:08 +08:00
parent 17ce3cf4c4
commit f4a68fca86

View File

@@ -1,5 +1,7 @@
# chessu # chessu
> This project is still in the early stages of development and should be considered highly unstable. Expect bugs, weird behavior, and bad code. (see #1)
Online 2-player chess. Live demo at [ches.su](https://ches.su) Online 2-player chess. Live demo at [ches.su](https://ches.su)
- React 18 - React 18
@@ -12,26 +14,19 @@ Online 2-player chess. Live demo at [ches.su](https://ches.su)
## Development ## Development
Root directory This repository is used for production deployments. You will need to make changes to the configuration to get this running locally.
```sh ```sh
npm install # install all dependencies npm install # install all dependencies
npm run dev # concurrently run frontend and backend test servers npm run dev # concurrently run frontend and backend dev servers
npm run build # build frontend and backend for production (see dist/ folders)
npm run react-dev # run frontend server only npm run react-dev # run frontend server only
``` ```
### Environment variables ### Environment variables
Client: `APIURL` Client: `APIURL` (or just change `apiUrl` in `/client/src/config/config.ts`)
Server: `SESSION_SECRET`, `PGUSER`, `PGPASSWORD`, `PGHOST`, `PGDATABASE`, `PGPORT` Server: `SESSION_SECRET`, `PGUSER`, `PGPASSWORD`, `PGHOST`, `PGDATABASE`, `PGPORT`
(also see server cors config and session middleware for local development)
## To-do (move this to issues):
- [] real-time games with chat & observer support
- [] user authentication with oauth2 support (optional)
- [] RESTful API for non-real-time games like daily chess