Modify readme

master
Araozu 2024-05-03 07:02:30 -05:00
parent 66ed4d7421
commit 47bff7b927
1 changed files with 8 additions and 30 deletions

View File

@ -1,34 +1,12 @@
## Usage
# Card-jong (frontend)
Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.
Card-jong is a Mahjong-like game, but uses
2 decks of cards instead of tiles.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
Has a SolidJS frontend and will connect to a
Go backend, which will have all the game logic
and state.
```bash
$ npm install # or pnpm install or yarn install
```
This frontend will only render the state received
from the backend.
### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
## Available Scripts
In the project directory, you can run:
### `npm run dev` or `npm start`
Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.<br>
### `npm run build`
Builds the app for production to the `dist` folder.<br>
It correctly bundles Solid in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
## Deployment
You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)