lgs / koa-blog-api

koa API

Koa API has a fleshed-out user login, signup, forgot password, email verification system using JWT, includes example seed data for users and blogs, and the following technologies listed below.

Technologies

• Koa 2.13.0
• Fully written using async/await & Classes
• Koa-Router
• Koa-Ratelimit with Redis
• Koa-Bodyparser
• KCors
• Koa-Json-Error for JSON requests/responses
• Koa-Useragent to get client user-agent data
• Bcrypt
• Sendgrid for emails
• JWT
• Nodemon for running in development
• Babel
• PM2 for running in production
• MongoDB with Mongoose (mongoose validation)
• Seed data for testing app
• TODO - testing
• log4js for logging
• Password recover system with token
• Multi user blog
• Image handling with sharp(format webp, with jpg fallback)

Installing / Getting started

###Important! rename example.env to .env and enter your credentials also make sure you have mongoDB running.

# install dependencies
npm install

# Development with nodemon with hot reload
npm start

# build for production with prettier and babel
npm run build

# serve in production using the pm2 ecosystem.json file
npm run production

# run prettier on the project
npm run pretty

# run tests
npm run test

# Rund seed data !important will rewrite your MongoDB data and delete all uploaded images##
npm run seed

General Information

User Authentication Process

User authentication process:

• User creates an account
• User verifies email
• User logs in
• The server sends and accessToken
• We take the accessToken and decode it using jwt-decode. This gets us the logged-in user's information`
• Each protected endpoint will be expecting you to attach the accessToken

PM2

This project features an ecosystem.json file that is the target of the PM2 implementation in production.

The src folder is the heart of the program.

Controllers

We use controllers to keep our router thin.

The controller's responsibility is to manage the request body and make sure it's nice and clean when it eventually

gets sent to a model to make database calls.

db

MongoDB with Mongoose for speed and fairly easy to used.

middleware

The custom middleware we're using is based on the koa-jwt library.

models

Our models folder where database calls are made and validation is performed

routes

This is where we do authentication for restricted URL

index.js

index.js it's the brain of the app.

Testing

Jest for testing WORK IN PROGRESS - TODO

License

copyright 2001 Oscar Quinteros

MIT