Skip to content

04) Project Structure

Anthony Quintero-Quiroga edited this page May 16, 2017 · 1 revision

Overview

├── README.md             - README
|                           
├── bower.json            - Package manifest file for Bower
├── config.codekit        - CodeKit configuration file
├── karma.config.js       - Config settings for karma
├── newrelic.js           - New Relic settings for app health monitoring
├── package.json          - Application dependencies 
├── Procfile              - Commands by application on Heroku
|
├── client/               - Front end files 
├── gulp/                 - Automation gulp scripts for build and testing 
├── routes/               - Slack integration found here
└── server/               - Back end files; main application(app.js) and routing
                            found here

Client (any unlisted folders are third-party or legacy files)

├── assets              - Folder containing all assets related to front end
|   ├── native          - Custom CSS and Javascript found here
|   └── views           - Views for the application
└── test                - Folder containing all tests for front end
    └── selenium        - Folder containing Selenium script to run tests during
                          deployment

Server

├── app.js              - Gets all routes with `requires('./routes')`
├── routes.js           - Main application routes
|
├── config              - Configuration files for database, schemas, and logs
├── models              - Database schema
│   ├── Appointment
│   ├── Company
│   ├── Employee
│   ├── Theme
│   └── VisitorList
├── notifications       - Non-functional; sends email and text notifications
├── routes              - Folder containing routes
│   ├── home.js         - Redirects to visitors.html
│   ├── appointment            
│   ├── company         
│   ├── employee        
│   ├── form            
│   ├── payment         
│   ├── theme           
│   └── visitorList     
├── socket              - Updates patient queue in real time
└── test                - Back end tests

Routing Structure (within server/; sans other files)

├── app.js              - Gets all routes with `requires('./routes')`
└── routes              - Folder containing routes
    ├── home.js         - Redirects to visitors.html
    ├── appointment            
    ├── company         
    ├── employee        
    ├── form            
    ├── payment         
    ├── theme           
    └── visitorList 

Clone this wiki locally