From 1fb4ff600c3d2f9224c786a28ada186a2a2d509b Mon Sep 17 00:00:00 2001 From: Nathaniel Tampus Date: Sun, 5 Feb 2023 14:20:43 +0800 Subject: [PATCH] update readme --- README.md | 23 ++--------------------- 1 file changed, 2 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 6d74ea9..60bcd4d 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,10 @@ Online 2-player chess. Live demo at [ches.su](https://ches.su) -- React 18 -- CSS Modules +- React (Remix) +- Tailwind CSS - [react-chessboard](https://github.com/Clariity/react-chessboard) - [chess.js](https://github.com/jhlywa/chess.js) - Express.js - socket.io - PostgreSQL - -## Development - -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 dev servers - -npm run react-dev # run frontend server only -``` - -### Environment variables - -Client: `APIURL` (or just change `apiUrl` in `/client/src/config/config.ts`) - -Server: `PORT`, `SESSION_SECRET`, `PGUSER`, `PGPASSWORD`, `PGHOST`, `PGDATABASE`, `PGPORT` -(also see server cors config and session middleware for local development)