Skip to content
forked from x249/blog-api

A blog API built with Fastify and Objection.js (Knex-based ORM)

License

Notifications You must be signed in to change notification settings

ryanSN/blog-api

 
 

Repository files navigation

Blog API

Build Status codecov Quality Gate Status

A blog API built with Fastify and Objection.js (Knex-based ORM)

Features

This API was built with the following technologies/paradigms/philosophies:

  • TypeScript
  • Fastify
  • Objection.js
  • Argon2
  • JWT Authentication & Authorization
  • Security & performance best-practices
  • Scalability

Requirements

  • Node.js >= 11 (LTS preferable)
  • PostgreSQL > 9
  • Argon2 build tools. See: Building Argon2

Optional

  • Docker >= 18

Build setup

$ yarn install
# install dependencies

$ yarn dev
# hot reloading server

$ yarn build
# build ts files

$ yarn start
# production server

Environment Variables (* = required)

*NODE_ENV=development
*PORT=3000
*SECRET='SUPER_SECRET' # JWT Secret
*DATABASE_URL='postgres://blog-user:password@localhost:5432/blog-prod'
LOG_LEVEL='info'
DISABLE_LOGGING=false

License

MIT

About

A blog API built with Fastify and Objection.js (Knex-based ORM)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.0%
  • JavaScript 2.4%
  • Dockerfile 0.6%