Improved folder structure

Author: Luciano Nooijen

README.md

@@ -44,10 +44,12 @@ to start using the package, create a new instance of the NodeBlog class
 
 ```js
 const nodeBlogConfig = {
+    client: 'YOUR_DB_CLIENT' // for more info, see https://knexjs.org/
     host: 'YOUR_DB_HOST'
     database: 'YOUR_DB_NAME'
     user: 'YOUR_DB_USER'
     pass: 'YOUR_DB_PASS'
+    debug: true || false
 };
 const nodeBlog = new NodeBlog(nodeBlogConfig);
 ```
@@ -80,8 +82,27 @@ For development, the following commands are available:
 | `yarn run migrate` | Migrates your database (normal one, not test database) to the most recent migration, seeds will not be ran |
 | `yarn run reinstall` | Deletes the `node_modules/` folder and reinstalls everything, if you get some stange dependency errors, run this command |
 
+### Folder structure
+
+```md
+├── controllers         Controller logic for the module based API
+├── database            All database related files
+│   ├── migrations
+│   └── seeds
+├── helpers             Helper files, for example: logger, database instance
+├── server              Server configuration
+│   ├── controllers
+│   ├── middleware
+│   │   └── modules
+│   └── routes
+└── tests               All tests written
+    ├── config
+    └── database
+```
+
 # Todo
 
+* Add Yarn seed command
 * Add authentication, password hashing -> also improve seed scripts
     * Add auth routes to get JWT
     * Using https://thejackalofjavascript.com/architecting-a-restful-node-js-app/
@@ -92,6 +113,7 @@ For development, the following commands are available:
 * Make sure the application is available both as a NPM module and as a standalone service
 * Integrate https://github.com/semantic-release/semantic-release
 * Split up standalone and module
+* Add XML feed
 
 ## Notes
 

controllers/controllers.js

@@ -1,9 +1,9 @@
-/* eslint-disable global-require */
+const Authors = require('./authors');
+const Users = require('./users');
+// const Categories = require('./categories');
+// const Posts = require('./posts');
 
 module.exports = {
-    Status: require('./status-controller'),
-    Authors: require('./authors-controller'),
-    Users: require('./users-controller'),
-    Categories: require('./categories-controller'),
-    Posts: require('./posts-controller'),
+    Authors,
+    Users,
 };

migrations/20181030235206_initial_setup.js renamed to database/migrations/20181030235206_initial_setup.js

@@ -26,7 +26,11 @@ module.exports = {
     },
     migrations: {
         tableName: 'knex_migrations',
+        directory: './database/migrations',
     },
     debug,
     asyncStackTraces: debug,
+    seeds: {
+        directory: './database/seeds',
+    },
 };

seeds/test-data.js renamed to database/seeds/test-data.js

@@ -1,3 +1,5 @@
+// TODO: Improve file: https://knexjs.org/#knexfile, move file to ./database
+
 require('dotenv').config();
 
 // eslint-disable-next-line
@@ -26,7 +28,11 @@ module.exports = {
     },
     migrations: {
         tableName: 'knex_migrations',
+        directory: './database/migrations',
     },
     debug,
     asyncStackTraces: debug,
+    seeds: {
+        directory: './database/seeds',
+    },
 };

knexfile-test.js

@@ -25,8 +25,8 @@
     "node": ">=8.0.0"
   },
   "scripts": {
-    "dev": "nodemon",
-    "start": "node server.js",
+    "dev": "nodemon server/server.js",
+    "start": "node server/server.js",
     "lint": "eslint --ext .jsx,.js,.ts .",
     "test": "NODE_ENV=TEST jest -i",
     "test:watch": "NODE_ENV=TEST jest -i --watch",

knexfile.js

@@ -1,4 +1,4 @@
-const { listAuthors } = require('./authors');
+const { listAuthors } = require('../../controllers/authors');
 
 const list = async (req, res) => {
     const authors = await listAuthors();

package.json

@@ -0,0 +1,13 @@
+const Status = require('./status-server');
+const Authors = require('./authors-server');
+const Users = require('./users-server');
+const Categories = require('./categories-server');
+const Posts = require('./posts-server');
+
+module.exports = {
+    Status,
+    Authors,
+    Users,
+    Categories,
+    Posts,
+};

app.js renamed to server/app.js

@@ -5,7 +5,7 @@ if (ENABLE_SQREEN === 'true' && NODE_ENV !== 'TEST') require('sqreen');
 /* eslint-enable */
 
 const app = require('./app');
-const logger = require('./helpers/logger');
+const logger = require('../helpers/logger');
 
 app.listen(PORT, () => {
     logger.info(`Server listening on port ${PORT}`); // eslint-disable-line

controllers/authors-controller.js renamed to server/controllers/authors-server.js

@@ -0,0 +1,45 @@
+const controllers = require('./controllers');
+
+const authors = {
+    getAuthors: controllers.Authors.list,
+    getAuthor: controllers.Authors.show,
+    addAuthor: controllers.Authors.create,
+    updateAuthor: controllers.Authors.update,
+    removeAuthor: controllers.Authors.remove,
+};
+
+const users = {
+    getUsers: controllers.Users.list,
+    getUser: controllers.Users.show,
+    addUser: controllers.Users.create,
+    updateUser: controllers.Users.update,
+    removeUser: controllers.Users.remove,
+};
+
+const categories = {
+    getCategories: controllers.Categories.list,
+    getCategory: controllers.Categories.show,
+    addCategory: controllers.Categories.create,
+    updateCategory: controllers.Categories.update,
+    removeCategory: controllers.Categories.remove,
+};
+
+const posts = {
+    getPosts: controllers.Posts.list,
+    getPost: controllers.Posts.show,
+    addPost: controllers.Posts.create,
+    updatePost: controllers.Posts.update,
+    removePost: controllers.Posts.remove,
+};
+
+const test = {
+    ...controllers,
+};
+console.log(test);
+
+module.exports = {
+    ...authors,
+    ...users,
+    ...categories,
+    ...posts,
+};

controllers/categories-controller.js renamed to server/controllers/categories-server.js

@@ -2,7 +2,7 @@
 // Until this has been resolved, this file will be archived for later use.
 
 const request = require('supertest');
-const app = require('../app');
+const app = require('../server/app');
 
 describe('Test the status paths', () => {
     test('The GET / route should give status code 200', async () => {