initial commit

Author: openmohan

.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Matches multiple files with brace expansion notation
+# Set default charset
+[*.{js,jsx,html,sass}]
+charset = utf-8
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+# don't use {} for single extension. This won't work: [*.{css}]
+[*.css]
+indent_style = space
+indent_size = 2

.eslintignore

@@ -0,0 +1,3 @@
+docs/
+log/
+public/

.eslintrc

@@ -0,0 +1,31 @@
+{
+  "env": {
+    "mocha": true,
+    "node": true
+  },
+  "globals": {
+    "connect": true
+  },
+  "plugins": [
+    "node",
+    "promise",
+    "security"
+  ],
+  "extends": [
+    "airbnb-base",
+    "eslint:recommended",
+    "plugin:node/recommended",
+    "plugin:promise/recommended",
+    "plugin:security/recommended"
+  ],
+  "rules": {
+    "comma-dangle": ["error", {
+      "arrays": "always-multiline",
+      "objects": "always-multiline",
+      "imports": "always-multiline",
+      "exports": "always-multiline",
+      "functions": "ignore"
+    }],
+    "max-len": 0
+  }
+}

.gitignore

@@ -0,0 +1,61 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# IDE
+.idea

Dockerfile

@@ -0,0 +1,8 @@
+FROM node:8.9-alpine
+
+WORKDIR /usr/app
+
+COPY package.json package-lock.json ./
+RUN npm install --loglevel=error --progess=false
+
+COPY . .

README.md

@@ -0,0 +1,40 @@
+# NodeJS Work Sample (roster editor)
+
+Welcome to the Digication work sample for NodeJS developers! This is our way to get some experience working with you and to get an idea about your level of NodeJS skills and knowledge about common npm packages. There is no official time-limit for this exercise, but you should finish it within a week. We encourage you to take the time you need in order to provide quality work that best reflects your skills.
+
+## Context
+
+A new course roster editor is needed! Imagine we are building an app for a university, where we need to provide a way for administrators to manage who should be teaching or taking a course. The frontend will be implemented at a later time. Today our goal is to create a basic version of the backend.
+
+## Data Models
+
+- The `Course` has `id` and `name` fields.
+- The `User` consists of `id`, `name` and `email`.
+
+### Relationships
+
+The model relationship in this example is kept as simple as possible, think of it this way:
+- Courses have many users assigned of which some can be flagged as faculty.
+- Users can be enrolled in many courses
+
+## API methods
+
+- Add the necessary functionality to add/remove users to/from courses. This should also allow mark/flag a user as faculty of the course.
+- Provide a way to get the users enrolled in a given course (and their faculty status).
+- You do not need to provide CRUD APIs for the Users and Courses models, but feel free to do so if you need them.
+
+## Technical Requirements
+
+You have to use NodeJS >10.0, expressjs 4.x and a relational database. This work sample already includes SQLite but feel free to use a different one. Regarding an ORM and SQL query builder we have selected `sequelize` but the final choice is up to you.
+
+Since your backend app will be used by other developers, documentation of the API (check the scripts in `package.json` for an idea how you could do this) and unit tests will be much appreciated. Please make sure to apply common design patterns and best practices.
+
+Please also point out which recommendations regarding security would you have, given that React will be used to build the frontend.
+
+## Encouragement
+
+Please don't go overboard with using external packages and don't try to introduce extra complexity in your code just for the sake of showcasing your skills. A simple and elegant solution for this should be your goal.
+
+Digication team members have worked through this work sample to make sure we are not asking for too much of your time. This shouldn't take you longer than a couple of hours depending on your knowledge and the bells and whistles you want to add.
+
+We are looking forward to hearing from you!

config/environments/development.js

@@ -0,0 +1,14 @@
+module.exports = {
+  database: {
+    dialect: 'sqlite',
+    storage: ':memory:',
+    logging: false,
+    define: {
+      underscored: true,
+      underscoredAll: true,
+      freezeTableName: true,
+      timestamps: true,
+    },
+    sync: { force: true },
+  },
+};

config/environments/test.js

@@ -0,0 +1,14 @@
+module.exports = {
+  database: {
+    dialect: 'sqlite',
+    storage: ':memory:',
+    logging: false,
+    define: {
+      underscored: true,
+      underscoredAll: true,
+      freezeTableName: true,
+      timestamps: true,
+    },
+    sync: { force: true },
+  },
+};

config/index.js

@@ -0,0 +1,9 @@
+const env = process.env.NODE_ENV || 'development';
+// eslint-disable-next-line security/detect-non-literal-require
+let config = require(`./environments/${env}`); // eslint-disable-line import/no-dynamic-require
+
+const defaultConfig = {};
+
+config = { ...defaultConfig, ...config };
+
+module.exports = config;