dvelo/mhsf-dev
1
0
Fork 0
mirror of https://github.com/DeveloLongScript/MHSF.git synced 2026-05-07 23:45:02 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: make contributing more clear

Browse Source
This commit is contained in:
dvelo 2024-12-27 12:59:44 -06:00 committed by GitHub
parent f3af51ae6b
commit 2d2417b9d1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -46,8 +46,14 @@ MONGO_DB="mongodb+srv://..."
## Smaller things (for production-ready servers)
### Cron
The Cron tasks used in MHSF are used to gather statistics on both online servers and Minehut as a whole. It works internally by pinging the `/servers` endpoint every 30 minutes from Minehut and pulling the data into the MongoDB database.
Cron can run in either a docker container or just be run in the background. To run it through Docker, use the following:
```bash
# Clone Cron tasks
git clone https://github.com/DeveloLongScript/MHSF
cd cron
# Install dependencies and build script on your local machine
yarn
yarn run build
@ -56,11 +62,15 @@ docker build .
```
To run it without Docker, use the following:
```bash
# Clone Cron tasks
git clone https://github.com/DeveloLongScript/MHSF
cd cron
yarn run build
```
> [!NOTE]
> You must have a `.env.local` with a MongoDB database (same `MONGO_DB` key) in the previous directory (for monorepo like management) running without Docker, and
> You must have a `.env.local` with a MongoDB database (same `MONGO_DB` key) **in the previous directory** (for monorepo-like management) running without Docker, and
> the same `.env.local` *but in the same directory when* using Docker.
### Reporting