:pencil: backend | updated README | using env variables

backend/README.md

@@ -14,9 +14,31 @@ You will need...
 ## :package: Installation
 
 1. Install dependencies with `npm install`
-2. Fill out your database connection details in `./config/dev.js`
-3. A test database container is provided and can be started with `docker-compose up -d`
-4. Populate some basic tables for your database using `npx knex migrate:latest`
+2. Copy the environments sample file from `./server/.env.sample` and rename it to `./server/.env`
+3. Fill out your database connection details in `./server/.env`
+4. A test database container is provided and can be started with `docker-compose --env-file ./backend/server/.env up -d`
+5. Populate some basic tables for your database using `npx knex migrate:latest`
+
+## :package: Migrations
+
+We use Knex.js,which comes with a couple nice database migration and seeding tools.
+Migrating tracks changes in schema. Migration steps are contained in the `./db/migrations` folder. Seeding adds dummy data once our database tables have been created and schemas are set. Starting seed steps are contained in `./db/seeds` and use the `mock.js` file as the main dummy data source.
+
+### Migrating
+* Run `npm run migrate` to run all migrations and establish the base schema
+* Run `npm run unmigrate` to roll back one migration
+
+### Seeding
+* Run `npm run seed` to seed the database with dummy data
+
+### Restarting
+Since we can't unseed the database, it's best to destroy the `dev` database and rebuild it.
+
+1. Stop the database by navigating to the project root directory `cd ../` and running `docker-compose down`
+2. Destroy the database volume `docker volume rm siimee_db`. BE CAREFUL.
+3. Restart the database while still at the project root with `docker-compose --env-file ./backend/server/.env up -d`
+4. Recreate schemas and tables but navigating to `./backend` and running `npm run migrate`
+5. Reseed the dummy data with `npm run seed`
 
 ## :electric_plug: Run
 

backend/server/.env.sample

@@ -3,5 +3,12 @@
 # Confused? See https://github.com/motdotla/dotenv
 #
 # e.g.
-# PORT=4000
-APP_SECRET=mysecret
+API_HOST=localhost
+API_PORT=3001
+APP_SECRET=mysecret
+
+DB_ROOT_PASSWORD=root
+DB_USER=root
+DB_NAME=test
+DB_HOST=localhost
+DB_TYPE=mysql

backend/server/manifest.js

@@ -11,13 +11,13 @@ Dotenv.config({ path: `${__dirname}/.env` });
 // Glue manifest as a confidence store
 module.exports = new Confidence.Store({
     server: {
-        host: 'localhost',
+        host: process.env.API_HOST,
         port: {
             $filter: 'NODE_ENV',
             $default: {
-                $param: 'PORT',
+                $param: 'API_PORT',
                 $coerce: 'number',
-                $default: 3001
+                $default: process.env.API_PORT
             },
             test: { $value: undefined }         // Let the server find an open port
         },
@@ -69,13 +69,13 @@ module.exports = new Confidence.Store({
                     $base: {
                         migrateOnStart: true,
                         knex: {
-                            client: 'mysql',
+                            client: process.env.DB_TYPE,
                             useNullAsDefault: true,
                             connection: {
-                                host : 'localhost',
-                                user : 'root',
-                                password : 'root',
-                                database : 'test'
+                                host : process.env.DB_HOST,
+                                user : process.env.DB_USER,
+                                password : process.env.DB_ROOT_PASSWORD,
+                                database : process.env.DB_NAME
                             }
                         }
                     },

docker-compose.yml

@@ -7,8 +7,8 @@ services:
         volumes:
           - siimee_db:/var/lib/mysql
         environment:
-          MYSQL_ROOT_PASSWORD: root
-          MYSQL_DATABASE: test
+          MYSQL_ROOT_PASSWORD: "${DB_ROOT_PASSWORD}"
+          MYSQL_DATABASE: "${DB_NAME}"
         ports:
           - '3306:3306'