Skip to content

Commit 3bd51ff

Browse files
committed
update: Updated the readme.md file
1 parent 379bb55 commit 3bd51ff

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,18 @@ With over 100 slash command and over 50 prefix commands, Testify is an open sour
8484
7. Copy your connection string and replace `<password>` with the password for the database user that you created earlier.
8585

8686

87+
- **Setting up the env file**
88+
89+
*If you go along with this, you can ignore the parts in the `Project Execution` that explain how to generate and fill in the `.env`*
90+
91+
1. For easy setup of the env files, ( `.env` & `.development.env` ) you can run the command `npm run setup-env:prod`
92+
2. Once you've ran the command, it generates a script in the console
93+
3. You need to then fill out the fields in the console. Fields marked with the text **"Required"** are you required fields and you need to fill those ones in. The script will not continue if you ignore to fill in those fields.
94+
4. Once you've filled in the field, it will write those fields into and generate the `.env`.
95+
5. Alternatively, you can ignore this and fill in the fields yourself by viewing the `.example.env` file.
96+
6. If you then want to setup the `.env.development` file, you can run the command `npm run setup-env:dev` and follow the steps above again.
97+
98+
8799
- **Project Execution**
88100

89101
1. Rename the filed named `example.env` to `.env`
@@ -107,6 +119,15 @@ With over 100 slash command and over 50 prefix commands, Testify is an open sour
107119
**Update Packages** - <br>
108120
To update all your dependencies, you can run the command `npm run update-packages`, this cycles through the dependencies and updates one's which are out of date.
109121

122+
**update-ytdl-core** - <br>
123+
To update the version of the `ytdl-core` package, you can run the command `npm run update-ytdl-core`, this updates the package to the most recent version to ensure the music system works.
124+
125+
**setup-env:prod** - <br>
126+
To run the setup of the `.env` file you can run the command `npm run setup-env:prod`, this generates a script in the console that generates a `.env` file and where you fill out the fields with whats required for the `.env` file and it writes it in the file.
127+
128+
**setup-env:dev** - <br>
129+
To run the setup of the `.env.development` file you can run the command `npm run setup-env:dev`, this generates a script in the console that generates a `.env.development` file and where you fill out the fields with whats required for the `.env.development` file and it writes it in the file.
130+
110131
## Setting-up-audit-logs
111132

112133
To set the advanced logs registry for the Testify audit-logs ( the event handler registers ) than follow this!

0 commit comments

Comments
 (0)