From f4a68fca8687a43863d9dfad38beeb447c8b9c7c Mon Sep 17 00:00:00 2001 From: Nathaniel Tampus Date: Tue, 3 Jan 2023 16:01:08 +0800 Subject: [PATCH] update readme --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e5afda3..b5ffe0c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 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) - React 18 @@ -12,26 +14,19 @@ Online 2-player chess. Live demo at [ches.su](https://ches.su) ## 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 npm install # install all dependencies -npm run dev # concurrently run frontend and backend test servers - -npm run build # build frontend and backend for production (see dist/ folders) +npm run dev # concurrently run frontend and backend dev servers npm run react-dev # run frontend server only ``` ### Environment variables -Client: `APIURL` +Client: `APIURL` (or just change `apiUrl` in `/client/src/config/config.ts`) Server: `SESSION_SECRET`, `PGUSER`, `PGPASSWORD`, `PGHOST`, `PGDATABASE`, `PGPORT` - -## 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 +(also see server cors config and session middleware for local development)