Added environment variables to README; added config/env/development.js.

Author: neonexus

.gitignore

@@ -135,6 +135,7 @@ lib-cov
 .idea/*
 !.idea/runConfigurations/
 !.idea/codeStyles/
+!.idea/dictionaries/
 
 # Elastic Beanstalk Files
 .elasticbeanstalk/*

.idea/dictionaries/neonexusdemortis.xml

@@ -15,7 +15,7 @@ This is an opinionated base [Sails v1](https://sailsjs.com) application, using W
 ## How to Use
 This repo is not installable via `npm`. Instead, Github provides a handy "Use this template" (green) button at the top of this page. That will create a special fork of this repo (so there is a single, init commit, instead of the commit history from this repo).
 
-Scripts built into [`package.json`](package.json):
+### Scripts built into [`package.json`](package.json):
 
 | Command       | Description
 |---------------|-------------------
@@ -26,10 +26,22 @@ Scripts built into [`package.json`](package.json):
 |npm run build  | Will run `npm run clean`, then will build production-ready files with Webpack in the `.tmp/public` folder.
 |npm run build:dev | Same thing as `npm run build`, except that it will not optimize the files, retaining newlines and empty spaces.
 |npm run clean  | Will basically delete everything in the `.tmp` folder.
-|npm run lines  | Will count the lines of code in the project, minus `.gitignore`'d files, for funzies. There are currently about **6k** custom lines in this repo (views, controllers, helpers, hooks, etc).
+|npm run lines  | Will count the lines of code in the project, minus `.gitignore`'d files, for funzies. There are currently about 6k custom lines in this repo (views, controllers, helpers, hooks, etc).
 |npm run test   | Run [Mocha](https://mochajs.org/) tests. Everything starts in the [`test/hooks.js`](test/hooks.js) file.
 |npm run coverage | Runs [NYC](https://www.npmjs.com/package/nyc) coverage reporting of the Mocha tests, which generates HTML in `test/coverage`.
 
+### Environment Variables used for remote servers:
+| Variable      | Description
+|---------------|----------------------
+| ASSETS_URL    | Webpack is configured to modify static asset URLs to point to a CDN, like CloudFront. MUST end with a slash " / ".
+| BASE_URL      | The address of the Sails instance.
+| DB_HOST       | The hostname of the datastore.
+| DB_USER       | Username for the datastore.
+| DB_PASS       | Password for the datastore.
+| DB_NAME       | The name of the database inside the datastore.
+| DB_PORT       | The port number for datastore.
+| DB_SSL        | If the datastore requires SSL, set this to "true".
+
 ## Request Logging
 Automatic incoming request logging, is a 2 part process. First, the [`request-logger` hook](api/hooks/request-logger.js) gathers info from the request, and creates a new [`RequestLog` record](api/models/RequestLog.js), making sure to mask anything that may be sensitive, such as passwords. Then, a custom response gathers information from the response, again, scrubbing sensitive data (using the [customToJSON](https://sailsjs.com/documentation/concepts/models-and-orm/model-settings?identity=#customtojson) feature of Sails models) to prevent leaking of password hashes, or anything else that should never be publicly accessible. The [`keepModelsSafe` helper](api/helpers/keep-models-safe.js) and the custom responses (such as [ok](api/responses/ok.js) or [serverError](api/responses/serverError.js)) are responsible for the final leg of request logs.
 
@@ -71,6 +83,7 @@ module.exports.bootstrap = function(next) {
 + [Sails Professional / Enterprise Options](https://sailsjs.com/enterprise)
 + [`react-bootstrap` Documentation](https://react-bootstrap.netlify.app/)
 + [Webpack Documentation](https://webpack.js.org/)
++ [Simple data fixtures for testing Sails.js](https://www.npmjs.com/package/fixted)
 
 
 ### Version info

README.md

@@ -1,7 +1,7 @@
 module.exports = {
-    friendlyName: 'Create Account',
+    friendlyName: 'Create User',
 
-    description: 'Create a new account.',
+    description: 'Create a new user.',
 
     inputs: {
         firstName: {
@@ -51,7 +51,7 @@ module.exports = {
             return exits.badRequest(isPasswordValid);
         }
 
-        User.create({
+        sails.models.user.create({
             id: 'c', // required, but auto-generated
             firstName: inputs.firstName,
             lastName: inputs.lastName,

api/controllers/admin/create-user.js

@@ -30,7 +30,7 @@ class SidebarNav extends React.Component {
                 <div id="sidebar-nav" className="hidden-sm">
                     <div className="logo">
                         <Link to="/admin/dashboard">
-                            <img src={logo} />
+                            <img src={logo} alt="Logo" />
                         </Link>
                     </div>
                     <div className="sidebar-wrapper">

assets/src/Admin/SidebarNav.jsx

@@ -4,7 +4,6 @@ class api {
     constructor(baseUrl) {
         this.baseUrl = baseUrl || process.env.baseUrl;
         this.request = request.agent(); // cookie handler
-        this.isActive = false;
         this.queue = [];
     }
 

assets/src/common/api.js

@@ -54,7 +54,7 @@ module.exports.datastores = {
         host: process.env.DB_HOST || 'localhost',
         user: process.env.DB_USER || 'root',
         password: process.env.DB_PASS || 'mypass',
-        database: process.env.DB || 'myapp',
+        database: process.env.DB_NAME || 'myapp',
         port: process.env.DB_PORT || 3306,
         charset: 'utf8mb4',
         collation: 'utf8mb4_general_ci',

config/datastores.js

@@ -0,0 +1,40 @@
+/**
+ * Development environment settings
+ *
+ * This file can include shared settings for a development team,
+ * such as API keys or remote database passwords.  If you're using
+ * a version control solution for your Sails app, this file will
+ * be committed to your repository unless you add it to your .gitignore
+ * file.  If your repository will be publicly viewable, don't add
+ * any private information to this file!
+ *
+ */
+
+module.exports = {
+    logSensitiveData: false, // never log sensitive data in remote development database
+
+    baseUrl: process.env.BASE_URL || 'https://my-api.app',
+    assetsUrl: process.env.ASSETS_URL || '', // Something like: https://my-cdn.app/ must end with /
+
+    /***************************************************************************
+     * Set the default database connection for models in the development       *
+     * environment (see config/datastores.js and config/models.js )           *
+     ***************************************************************************/
+
+    datastores: {
+        host: process.env.DB_HOST || 'localhost',
+        user: process.env.DB_USER || 'root',
+        password: process.env.DB_PASS || 'mypass',
+        database: process.env.DB_NAME || 'myapp',
+        port: process.env.DB_PORT || 3306,
+        ssl: (process.env.DB_SSL === 'true')
+    },
+
+    models: {
+        migrate: 'safe' // This is set as safe, so remote development machines are behaving like remote production machines. Use local.js to override.
+    },
+
+    blueprints: {
+        shortcuts: false // don't accidentally expose API routes in a remote environment
+    }
+};

config/env/development.js

@@ -23,8 +23,8 @@ module.exports = {
 
     logSensitiveData: false, // never log sensitive data in production database
 
-    baseUrl: 'https://myapi.app',
-    assetsUrl: 'https://my-cdn.app/', // must end with /
+    baseUrl: process.env.BASE_URL || 'https://my-api.app',
+    assetsUrl: process.env.ASSETS_URL || '', // Something like: https://my-cdn.app/ must end with /
 
     /**************************************************************************
      *                                                                         *
@@ -50,15 +50,12 @@ module.exports = {
          *                                                                          *
          ***************************************************************************/
         default: {
-            host: process.env.RDS_HOSTNAME || 'localhost',
-            user: process.env.RDS_USERNAME || 'produser',
-            password: process.env.RDS_PASSWORD || 'myprodpassword',
-            database: process.env.RDS_DB_NAME || 'proddatabase',
-            port: process.env.RDS_PORT || 3306,
-            charset: 'utf8mb4',
-            collation: 'utf8mb4_general_ci',
-            timezone: 'UTC',
-            ssl: (process.env.RDS_SSL === 'true')
+            host: process.env.DB_HOSTNAME || 'localhost',
+            user: process.env.DB_USERNAME || 'produser',
+            password: process.env.DB_PASSWORD || 'myprodpassword',
+            database: process.env.DB_NAME || 'proddatabase',
+            port: process.env.DB_PORT || 3306,
+            ssl: (process.env.DB_SSL === 'true')
         }
     },
 
@@ -214,11 +211,12 @@ module.exports = {
         // https://jsfiddle.net/fsbd3ey5/1/
         secret: process.env.SESSION_SECRET, // DO NOT STORE THIS IN SOURCE CONTROL!!!
 
-        host: process.env.RDS_HOSTNAME,
-        port: process.env.RDS_PORT,
-        user: process.env.RDS_USERNAME,
-        password: process.env.RDS_PASSWORD,
-        database: process.env.RDS_DB_NAME,
+        host: process.env.DB_HOSTNAME || 'localhost',
+        user: process.env.DB_USERNAME || 'produser',
+        password: process.env.DB_PASSWORD || 'myprodpassword',
+        database: process.env.DB_NAME || 'proddatabase',
+        port: process.env.DB_PORT || 3306,
+        ssl: (process.env.DB_SSL === 'true')
     },
 
 

config/env/production.js

@@ -54,7 +54,7 @@ exports.mochaHooks = {
                 sails: true,
                 _,
                 async: false,
-                models: true
+                models: false
             }
         }), function(err, sailsApp){
             if (err) {
@@ -64,7 +64,6 @@ exports.mochaHooks = {
             // sanity checks
             should.exist(sails);
             sails.should.have.property('models');
-            sails.models.should.have.property('requestlog');
 
             fs.readdir( path.join(__dirname, '../api/models'), (error, files) => {
                 should.not.exist(error);

test/hooks.js

@@ -1,9 +1,15 @@
 const userFixtures = require('../../fixtures/User.js');
 
-describe('User', function() {
+describe('User Model', function() {
+    before(function() {
+        // sanity checks
+        should.exist(sails);
+        sails.models.should.have.property('user');
+    });
+
     describe('.find()', function() {
         it('should return all user fixtures', async function() {
-            const foundUsers = await User.find({});
+            const foundUsers = await sails.models.user.find({});
             foundUsers.should.be.an('array');
             foundUsers.should.have.lengthOf(userFixtures.length);
 
@@ -17,7 +23,7 @@ describe('User', function() {
 
     describe('.toJSON()', function() {
         it('should not expose sensitive information to the outside world', async function() {
-            const foundUsers = await User.find();
+            const foundUsers = await sails.models.user.find({});
             foundUsers.should.be.an('array');
 
             // make sure password is never exposed to the outside world