50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# Freechess
|
|
|
|
Freechess is an open-source chess web app to play, view and analyze your chess games for free from anywhere with Stockfish !
|
|
|
|
Built with [Next.js](https://nextjs.org/docs), [React](https://react.dev/learn/describing-the-ui), [Material UI](https://mui.com/material-ui/getting-started/overview/), and [TypeScript](https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html).
|
|
|
|
Deployed on [Firebase](https://firebase.google.com/docs/hosting), see it live [here](https://freechess.web.app).
|
|
|
|
## Running the app locally in dev mode
|
|
|
|
At least [Node.js](https://nodejs.org) 18.17 is required.
|
|
|
|
Install the dependencies :
|
|
|
|
```bash
|
|
npm i
|
|
```
|
|
|
|
Run the development server :
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) in the browser to see the app running.
|
|
|
|
The app will automatically refresh on any source file change.
|
|
|
|
## Lint
|
|
|
|
Run it with :
|
|
|
|
```bash
|
|
npm run lint
|
|
```
|
|
|
|
## Deploy
|
|
|
|
To deploy the app, install the [Firebase CLI](https://firebase.google.com/docs/cli) and authenticate, then run :
|
|
|
|
```bash
|
|
npm run deploy
|
|
```
|
|
|
|
## License
|
|
|
|
GNU General Public License v3.0.
|
|
|
|
See [COPYING](COPYING) to see the full text.
|