forked from noxious/server
Added README.md, started refactoring init. command
This commit is contained in:
40
README.md
Normal file
40
README.md
Normal file
@ -0,0 +1,40 @@
|
||||
# Noxious game server
|
||||
|
||||
This is the server for the Noxious game.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone the repository
|
||||
2. Install dependencies with `npm install`
|
||||
3. Copy the `.env.example` file to `.env` and fill in the required variables
|
||||
4. Run the server with `npm run dev`
|
||||
|
||||
## Commands
|
||||
|
||||
### `npm run dev`
|
||||
|
||||
Starts the server in development mode.
|
||||
|
||||
### `npm run build`
|
||||
|
||||
Builds the server for production.
|
||||
|
||||
### `npm run format`
|
||||
|
||||
Formats the code using Prettier.
|
||||
|
||||
## MikroORM
|
||||
|
||||
MikroORM is used as the ORM for the server.
|
||||
|
||||
### Create init. migrations
|
||||
|
||||
Run `npx mikro-orm migration:create --initial` to create a new initial migration.
|
||||
|
||||
### Create migrations
|
||||
|
||||
Run `npx mikro-orm migration:create` to create a new migration.
|
||||
|
||||
### Apply migrations
|
||||
|
||||
Run `npx mikro-orm migration:up` to apply all pending migrations.
|
Reference in New Issue
Block a user