Snail Mail Management Software

Objective

To create a open source tool to track and manage an organizations' snail mail.

Git Commit StyleGuide

To ensure commit messages are consistent and easily understandable, please read and follow the below style guide.

Udacity Commit Style Guide

1. feat: a new feature
2. fix: a bug fix
3. docs: changes to documentation
4. style: formatting, missing semi colons, etc; no code change
5. refractor: refractor production code
6. test: adding tests, refractoring test; no production code change
7. chore: updating build tasks, package manager configs; etc; no production code change

Technology Stack

1. Front end JavaScript Framework - currently AngularJS (to be changed to React)
2. Front End CSS Framework - Bulma
3. Back end Framework - NodeJS, ExpressJS
4. Database - MYSQL
5. Object Relational Mapper - KnexJS
6. In Memory Data Store - Redis
7. Testing Frameworks - Mocha and Chai

JavaScript StyleGuide

To ensure the codebase conforms to a standard, the following JavaScript Style Guide will be adopted:

1. Airbnb

Project Folder Structure

• api - Contains all endpoints and middlewares
• bin - Contains entry point for the application.
• config - To be removed
• models - Files defining each model or table within the database
• node_modules - All node modules required for the project
• public - All front end code (javascript and stylesheets)
• services - Files interacting with the database or other services
• test - Contains test files for each endpoint
• views - Contains ejs files used to render server side template
  • .env - Contains environmental variables such as database connection user name and passwords
  • .eslintrc.js
  • .gitignore
  • app.js
  • CONTRIBUTING.md
  • LICENSE
  • package-lock.json
  • package.json
  • README.md