1.0.0 • Published 2 years ago

hbs_auth_temp v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Purpose

The purpose of this repository is to create a basic template for future web application development, including aws development.

Setup

  1. npm install
  2. Create your own database (which can be configured in .dotnev)
DB_NAME=
DB_USERNAME=
DB_PASSWORD
  1. if on mac, start postgres server and create database
  1. Initiate knex database. In node terminal (cd into current folder)
knex run latest
  1. Type in npm run test
  2. Type in npm run start

To Add Extra Routes:

  1. Go to controller, and copy the problem folder (that's a template for any additional routes that you may want to add)
  2. Go to service class, and again, check out the problem folder
  3. Update any routes
  4. Make sure to add jsdocs documentation

Important things to know:

Requirements

Service

Routes

Use Cases

Actors

The actors of this handlebars template are the users and the developer.

Good documentation

  • Swagger and jsdocs commands

Clear instructions as how to add routes

Simple and easy to understand

Important Vocabulary

WordWhere it occursHow it works
Word

User Stories :telescope:

  1. Users will be able to look through the various examples and understand how to test well.

Sprint :athletic_shoe:

Done?ComponentPriorityEstimated TimeActual Time
xThis checklistH30 mins
xIdentify and install the required librariesH30 mins
xCreate new databaseH30 mins
Implement jsdoc and swaggerM25 mins
Implement controller and serviceH1 hr
Write testsM
Includes very simple linksM
Include clear instructions on usageM
Documented controller and service classesM
Documented controller and service classesM

Daily Stand Up :hourglass:

Issues and Resolutions :flashlight:

ERROR: :gear: RESOLUTION: :key:

IssueWhere it occursPossible solutionActual solution
Creating a checklistH2hrs2.5hrs

What is one thing that I learned from doing this project? :books: