Skip to content

Latest commit

 

History

History
146 lines (115 loc) · 2.44 KB

README.md

File metadata and controls

146 lines (115 loc) · 2.44 KB

MEDIC MANAGER

Project 2 - Full Stack Web Application

Description

Medic Manager is an interactive system for storage expiry tracking and replacement schedules featuring email reminders and a chatbot.

Tech Stack

  • Node Js
  • Express Js
  • Restful API
  • Handlebars Js
  • MySQL + Sequelize
  • Get and Post Routes
  • NPM packages
  • Emailer
  • Chatbot
  • MVC (Model View Controller) paradigm
  • Authentication
  • Heroku deployment

How to contribute:

To initially download

clone [email protected]:bernardjbs/Project-2.git

How to move to a new branch for new work (do before adding adding new info to staging area once the repo is clones/pulled)

git checkout -b branch_name

Subsequent updates

git pull (any changes)
git add -A (new work on your computer)
git commit (Description of work)
git push -u [your branch name]

How to run application from command line for testing

Credentials

Head to file .env
Input credentials

Dependencies

Install dependencies
npm i

Database

Change directory to /db
mysql -u root password
Create Database
SOURCE schema.sql

Seed

Seed database from command line (not mysql)
npm run seed

Begin Application

Use nodemon
npm run watch

OR

Start application
npm start

File Structure Breakdown

Config ->

Server connection

Controllers ->

Requests & database querying

DB ->

Establish database

Models ->

Hold model(database table info)

Public ->

Hold information that will be utilized on the front end

Seeds ->

Hold information that will be imported into models (the tables that are created) for testing or initial establishment of information.

Utils ->

Utilized by the view to handle login requests, or data manipulation

Views ->

Handlebars templating folder

Contributors

Extras

Screenshot

Homepage

Homepage

Questions

Any questions please email [email protected] (N.B this is a fictional email until official email is created)

Copyright

©️2022 MEDIC MANAGER®️