1.0.0 • Published 2 years ago
hbs_auth_temp v1.0.0
Purpose
The purpose of this repository is to create a basic template for future web application development, including aws development.
Setup
- npm install
- Create your own database (which can be configured in .dotnev)
DB_NAME=
DB_USERNAME=
DB_PASSWORD
- if on mac, start postgres server and create database
- Initiate knex database. In node terminal (cd into current folder)
knex run latest
- Type in npm run test
- Type in npm run start
To Add Extra Routes:
- Go to controller, and copy the problem folder (that's a template for any additional routes that you may want to add)
- Go to service class, and again, check out the problem folder
- Update any routes
- 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
Word | Where it occurs | How it works |
---|---|---|
Word |
User Stories :telescope:
- Users will be able to look through the various examples and understand how to test well.
Sprint :athletic_shoe:
Done? | Component | Priority | Estimated Time | Actual Time |
---|---|---|---|---|
x | This checklist | H | 30 mins | |
x | Identify and install the required libraries | H | 30 mins | |
x | Create new database | H | 30 mins | |
Implement jsdoc and swagger | M | 25 mins | ||
Implement controller and service | H | 1 hr | ||
Write tests | M | |||
Includes very simple links | M | |||
Include clear instructions on usage | M | |||
Documented controller and service classes | M | |||
Documented controller and service classes | M |
Daily Stand Up :hourglass:
Issues and Resolutions :flashlight:
ERROR: :gear: RESOLUTION: :key:
Issue | Where it occurs | Possible solution | Actual solution |
---|---|---|---|
Creating a checklist | H | 2hrs | 2.5hrs |
What is one thing that I learned from doing this project? :books:
1.0.0
2 years ago