haunter/chesskit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc : update Readme

Browse Source
This commit is contained in:
GuillaumeSD
2024-02-25 03:26:19 +01:00
parent fae1441232
commit 003edaead9
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -4,29 +4,31 @@ Freechess is an open-source chess GUI to store, view and analyze your chess game
It is 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). It is 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).
It is deployed on [Firebase](https://firebase.google.com/docs/hosting), you can see it live [here](https://freechess.web.app). It is deployed on [Firebase](https://firebase.google.com/docs/hosting), see it live [here](https://freechess.web.app).
## Getting Started ## Running the app in dev mode
First, you need at least node18 & npm installed on your machine. Then, you can install the dependencies : Node 18 and npm are required.
Install the dependencies :
```bash ```bash
npm i npm i
``` ```
Then, you can run the development server : Run the development server :
```bash ```bash
npm run dev npm run dev
``` ```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the app running. Open [http://localhost:3000](http://localhost:3000) in the browser to see the app running.
The development server will automatically reload if you change any of the source files. The app will automatically refresh on any source file change.
## Lint ## Lint
ESLint is configured with this project. You can run it with : Run it with :
```bash ```bash
npm run lint npm run lint
@@ -34,7 +36,7 @@ npm run lint
## Deploy ## Deploy
To deploy the app, you first need to install the firebase CLI, then run : To deploy the app, install the [Firebase CLI](https://firebase.google.com/docs/cli) and authenticate, then run :
```bash ```bash
npm run deploy npm run deploy