update readme

This commit is contained in:
Jonny_Bro (Nikita) 2024-08-29 10:40:38 +05:00
parent 766c915de1
commit 8674acd5ef
No known key found for this signature in database
GPG key ID: 3F1ECC04147E9BD8

View file

@ -1,4 +1,4 @@
# Beatrun Courses Database
# Beatrun Courses Database Server
Beatrun courses database written in JavaScript using [Node.js](https://nodejs.org).\
This is project is a rewrite of this [fork](https://github.com/JonnyBro/beatrun-courses-server) from PHP to JavaScript. Original project was made by [relaxtakenotes](https://github.com/relaxtakenotes/beatrun-courses-server).
@ -6,20 +6,9 @@ This is project is a rewrite of this [fork](https://github.com/JonnyBro/beatrun-
## Installation
```bash
git clone https://git.jonnybro.ru/jonny_bro/beatrun-courses-server-express courses-server
cd courses-server
mv config.example.js config.js
pnpm install
pnpm build
pnpm start
docker compose up --build -d
```
> [!NOTE]
> You also can use NPM as your package manager.
## TODO
* [X] Rewrite admin page.
* [X] Make admin page look better.
* [X] Refactor some stupid code that I will find.
* [ ] Add something else? (leaderboards???).