Skip to content

Commit e38e34a

Browse files
authored
Revise README for Hitori Mahjong project
Updated README to include new project name and development instructions.
1 parent 7d4100d commit e38e34a

File tree

1 file changed

+6
-77
lines changed

1 file changed

+6
-77
lines changed

README.md

Lines changed: 6 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,8 @@
1-
# Welcome to React Router!
2-
3-
A modern, production-ready template for building full-stack React applications using React Router.
4-
5-
## Features
6-
7-
- 🚀 Server-side rendering
8-
- ⚡️ Hot Module Replacement (HMR)
9-
- 📦 Asset bundling and optimization
10-
- 🔄 Data loading and mutations
11-
- 🔒 TypeScript by default
12-
- 🎉 TailwindCSS for styling
13-
- 📖 [React Router docs](https://reactrouter.com/)
14-
15-
## Getting Started
16-
17-
### Installation
18-
19-
Install the dependencies:
20-
21-
```bash
22-
npm install
23-
```
24-
25-
### Development
26-
27-
Start the development server with HMR:
28-
29-
```bash
30-
npm run dev
31-
```
32-
33-
Your application will be available at `http://localhost:5173`.
34-
35-
## Previewing the Production Build
36-
37-
Preview the production build locally:
38-
39-
```bash
40-
npm run preview
41-
```
42-
43-
## Building for Production
44-
45-
Create a production build:
46-
47-
```bash
48-
npm run build
49-
```
50-
51-
## Deployment
52-
53-
Deployment is done using the Wrangler CLI.
54-
55-
To build and deploy directly to production:
56-
57-
```sh
58-
npm run deploy
59-
```
60-
61-
To deploy a preview URL:
62-
63-
```sh
64-
npx wrangler versions upload
65-
```
66-
67-
You can then promote a version to production after verification or roll it out progressively.
68-
1+
# 一人麻雀(Hitori Mahjong)
2+
## development
693
```sh
70-
npx wrangler versions deploy
4+
bun install
5+
cp .env.example .env
6+
docker compose up
7+
bun dev
718
```
72-
73-
## Styling
74-
75-
This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer.
76-
77-
---
78-
79-
Built with ❤️ using React Router.

0 commit comments

Comments
 (0)