https://github.com/tremainebuchanan/mail-mgmt-app

Snail Mail Management Software
https://github.com/tremainebuchanan/mail-mgmt-app

angularjs bulma hacktoberfest hacktoberfest2019 nodejs saas

Last synced: 2 months ago
JSON representation

Snail Mail Management Software

• Host: GitHub
• URL: https://github.com/tremainebuchanan/mail-mgmt-app
• Owner: tremainebuchanan
• License: apache-2.0
• Created: 2019-10-05T01:31:53.000Z (over 5 years ago)
• Default Branch: production
• Last Pushed: 2023-01-24T00:43:22.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T06:46:19.946Z (9 months ago)
• Topics: angularjs, bulma, hacktoberfest, hacktoberfest2019, nodejs, saas
• Language: HTML
• Size: 465 KB
• Stars: 1
• Watchers: 4
• Forks: 9
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  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](http://udacity.github.io/git-styleguide/, "Udacity 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](https://angularjs.org/, "AngularJS") (to be changed to [React](https://reactjs.org/,"React"))

2. Front End CSS Framework - [Bulma](https://bulma.io/, "Bulma")

3. Back end Framework - [NodeJS](https://nodejs.org/en/,"NodeJS"), [ExpressJS](https://expressjs.com/, "Express")

4. Database - [MYSQL](https://www.mysql.com/,"MYSQL") 

5. Object Relational Mapper - [KnexJS](https://knexjs.org/,"KnexJS")

6. In Memory Data Store - [Redis](https://redis.io/, "Redis")

7. Testing Frameworks - [Mocha](https://mochajs.org/, "Mocha") and [Chai](https://www.chaijs.com/, "Chai") 

## JavaScript StyleGuide

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

1. [Airbnb](https://github.com/airbnb/javascript, "Airbnb JavaScript Style Guide")

## 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`