StyAndCo/zeppelin
3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-05-21 16:55:03 +00:00
Code Releases Activity

Fix documentation per review comments

Browse source
This commit is contained in:
Bluenix 2021-08-15 14:56:04 +02:00
parent 3f6eea7468
commit bfa81b002f
No known key found for this signature in database
GPG key ID: 1C1ED07E6FC8AA48
1 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -26,7 +26,7 @@ See <https://zeppelin.gg/> for more details.
These instructions are intended for bot development only, they are not recommended for self-hosting. These instructions are intended for bot development only, they are not recommended for self-hosting.
👉 **No support is guaranteed for self-hosting the bot!** 👈 👉 **No support is offered for self-hosting the bot!** 👈
### Running the backend ### Running the backend
@ -37,12 +37,13 @@ These instructions are intended for bot development only, they are not recommend
3. Make a copy of `bot.env.example` and `api.env.example` (removing the `.example` suffix), fill in the values. 3. Make a copy of `bot.env.example` and `api.env.example` (removing the `.example` suffix), fill in the values.
There are defaults for your convenience, feel free to replace these. There are defaults for your convenience, feel free to replace these.
4. Setup the database schema, use `npm run migrate-dev`. 4. Setup the database: `npm run migrate-dev`
5. Run `npm run build` followed by the desired start script: 5. To start the backend, there are two alternatives:
- **Recommended** is to use `npm run watch`, this starts both the bot and api server and automatically restarts on save. - **It is recommended** to use `npm run watch` for development. This will automatically restart on save
- `npm run start-bot-dev` to start the bot. - Run `npm run build` followed by the desired start script:
- `start-api-dev` to start the api server. - `npm run start-bot-dev` to start the bot.
- `start-api-dev` to start the api server.
6. On the first run you need to add your guild to the `allowed_guilds` table, otherwise the bot leaves on next restart. 6. On the first run you need to add your guild to the `allowed_guilds` table, otherwise the bot leaves on next restart.
Use the following queries (replacing the all-caps variables): Use the following queries (replacing the all-caps variables):
@ -68,8 +69,8 @@ VALUES (2, "guild-GUILD_ID", "{\"prefix\": \"!\", \"levels\": {\"YOUR_ID\": 100}
3. Make a copy of `.env.example` called `.env`, fill in the values. 3. Make a copy of `.env.example` called `.env`, fill in the values.
4. Run the desired start script: 4. Run the desired start script:
- `npm run build` compiles the dashboard's static files to `dist/` which can then be served with any web server
- `npm run watch` runs webpack's dev server that automatically reloads on save - `npm run watch` runs webpack's dev server that automatically reloads on save
- `npm run build` compiles the dashboard's static files to `dist/` which can then be served with any web server
### Notes ### Notes