krgamestudios/MERN-template
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated tutorial setup (markdown)

Kayne Ruse
2021-08-22 02:35:17 +10:00
parent 3c1a0be525
commit 7cdc484385
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tutorial-setup.md
+6 -4
@@ -37,6 +37,7 @@ In a perfect world, deploying to a server would be as easy as:
```
git clone https://github.com/krgamestudios/MERN-template.git
cd MERN-template
node configure-script.js
docker-compose up --build
```
@@ -61,11 +62,12 @@ Project DB Password (pikachu):
News Name (news):
News Web Address (news.example.com):
News DB Username (news):
News DB Password (charizard):
News DB Password (venusaur):
Auth Name (auth):
Auth Web Address (auth.example.com):
Auth Reset Addr (example.com/reset):
Auth DB Username (auth):
Auth DB Password (venusaur):
Auth DB Password (charizard):
Email SMTP (smtp.example.com):
Email Address (foobar@example.com):
Email Password (foobar):
@@ -109,13 +111,13 @@ Finally, run this to deploy the project:
docker-compose up --build
```
You might need sudo, and you could ad `-d` to detach the process from the console. Now, navigate to your main web address, and you should see the empty homepage. If there are any issues, check the [troubleshooting page](troubleshooting).
You might need sudo, and you could add `-d` to detach the process from the console. Now, navigate to your main web address, and you should see the empty homepage. If there are any issues, check the [troubleshooting page](troubleshooting).
## Setting Up Development
For development, you'll need Nodejs and MariaDB installed and working on your machine. Remember to run `npm install` in the git repo after cloning to get all of the libraries.
First, run `sql/create_database.sql` on your mariaDB instance - this will create a database called `template` and a user called `template`@`%`.
First, run `sql/create_database.sql` on your mariaDB instance - this will create a database called `template` and a user called `template`@`%` with the password `pikachu`.
Next, copy `.envdev` into a new file called `.env` (`SECRET_ACCESS` should have the value `access`, this is the key for the dev-servers that you're about to connect to).