Skip to content

Commit

Permalink
docs: Add build and start instructions to README
Browse files Browse the repository at this point in the history
- Included detailed steps for installation, build setup, and running the project locally.
- Clarified prerequisites and provided commands for setting up dependencies.
- Updated README to ensure clear and concise instructions for developers.
  • Loading branch information
TKanX committed Jun 20, 2024
1 parent 5f17843 commit 8656554
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Tridecco Game Client is a frontend application designed to support Tridecco game

![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)
![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)

### Language

Expand All @@ -26,3 +27,30 @@ Tridecco Game Client is a frontend application designed to support Tridecco game
### Environment Requirements

- Node.js

### Setting Up the Server

1. Clone the repository:

```bash
git clone https://github.com/tridecco/game-client-web.git
cd game-client-web
```

2. Install dependencies:

```bash
npm install
```

3. Compile Tailwind CSS and PostCSS:

```bash
npm run build:css
```

4. Start the server:

```bash
node server
```

0 comments on commit 8656554

Please sign in to comment.