MrDiderot/Michess
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

switch to pnpm workspaces

Browse Source
This commit is contained in:
Nathaniel Tampus
2023-07-27 16:28:10 +08:00
parent db3b844802
commit f846e8f15f
5 changed files with 4437 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -29,7 +29,7 @@ Built with Next.js 13, Tailwind CSS + daisyUI, react-chessboard, chess.js, Expre
> Node.js 18 or newer is recommended.
This project is structured as a monorepo using npm workspaces, separated into three packages:
This project is structured as a monorepo using **pnpm** workspaces, separated into three packages:
- `client` - Next.js application for the front-end, deployed to [ches.su](https://ches.su) via Vercel.
- `server` - Node/Express.js application for the back-end, deployed to [server.ches.su](https://server.ches.su) via Railway.
@@ -37,17 +37,18 @@ This project is structured as a monorepo using npm workspaces, separated into th
### Getting started
1. Install the necessary dependencies by running `npm install` in the root directory of the project.
2. In the `server` directory, create a `.env` file for your PostgreSQL database. You can try [ElephantSQL](https://www.elephantsql.com/) or [Aiven](https://aiven.io/postgresql) for a free hosted database.
1. Install [pnpm](https://pnpm.io/installation).
2. Install the necessary dependencies by running `pnpm install` in the root directory of the project.
3. In the `server` directory, create a `.env` file for your PostgreSQL database. You can try [ElephantSQL](https://www.elephantsql.com/) or [Aiven](https://aiven.io/postgresql) for a free hosted database.
```env
PGHOST=db.example.com
PGUSER=exampleuser
PGPASSWORD=examplepassword
PGDATABASE=chessu
```
3. Run the development servers with `npm run dev`.
- To run the frontend and backend servers separately, use `npm run dev -w client` and `npm run dev -w server`, respectively.
4. You can now access the frontend at http://localhost:3000 and the backend at http://localhost:3001.
4. Run the development servers with `pnpm dev`.
- To run the frontend and backend servers separately, use `pnpm dev:client` and `pnpm dev:server`, respectively.
5. You can now access the frontend at http://localhost:3000 and the backend at http://localhost:3001.
## Contributing