Skip to content

Commit 9ef8ae9

Browse files
committed
Documentation
1 parent 166356c commit 9ef8ae9

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,15 @@ Create a folder within your projects directory and run the following inside it:
3131
Once finished:
3232

3333
- In the folder from where you ran the git command, run `npm install`, which will install the required packages.
34-
- Rename `config.js.example` to `config.js`, and give it the required intents and any partials you may require.
35-
- Rename `.env-example` to `.env` and put in your bot token in it and save.
36-
34+
- Make sure you're using node.js `v16.14.2`
35+
- Rename `.env-example` to `.env` and put each key inside as follows
36+
- DISCORD_TOKEN - Your bot token
37+
- OWNER - Your discord ID
38+
- API_URL - The URL of your API instance (for example: http://localhost:3000/v1, must include /v1/ at the end)
39+
- API_KEY - The API key (Can be anything, shared between bot and API)
40+
- GOOGLE_API_KEY - Google maps API key
41+
- Set up the [API](https://github.com/Project-Skill-Tree/Skill-Tree-API)
42+
- Set up the [editor](https://github.com/Project-Skill-Tree/Skill-Tree-Editor)
3743
## Starting the bot
3844

3945
To start the bot, in the command prompt, run the following command:
@@ -46,4 +52,4 @@ Read the [documentation wiki](https://www.projectskilltree.com)
4652
Read [Installation](#installation) to get started.
4753

4854
This project uses Eslint for code formatting. Install it [here](https://eslint.org/) and run it before making a pull request with your changes.<br>
49-
You can run Eslint via `npx eslint --fix .`.
55+
You can run Eslint via `npx eslint --fix .`.

0 commit comments

Comments
 (0)