Skip to content

This is probably one of the smallest APIs ever written

Notifications You must be signed in to change notification settings

codestaintin/UserAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UserAPI

A simple registration and log in API built using NodeJS and Postgres

Application Features

This API has just two features used in buidling any application the involves User sign up and sign in. The API uses JSON Web Token (JWT) for authentication and to the an extent the API is properly validated

What users can do with the UserAPI

  • Register (sign Up)
  • Log in (sign In)

Built with

  • NodeJS is a JavaScript runtime built on Chrome's V8 JavaScript engine
  • Express JS A minimalist web framework
  • Sequelize Sequelize is a promise-based ORM for Node.js v4 and up. It supports the dialects PostgreSQL, MySQL, SQLite and MSSQL and features solid transaction support, relations, read replication and more.
  • PostgreSQL A powerful, open source object-relational database system.
  • ESLint provides a pluggable linting utility for JavaScript.
  • Mocha Mocha is a feature-rich JavaScript test framework running on NodeJS for testing Javascript applications.

Installation

  • Install NodeJS and PostgreSQL on your machine
  • Clone the repository by running git clone https://github.com/codestaintin/UserAPI.git
  • Change to working directory to UserAPI cd /UserAPI
  • Run npm install to install all dependencies
  • It is advisable to install sequelize CLI globally to ease database migrations npm install -g sequelize-cli
  • Create a .env file that conforms to the .env.Sample provided for your environment variables
  • Run sequelize db:migrate for database migrations
  • Run sequelize to have access to all other sequelize commands, e.g sequelize db:migrate:undo:all is for undoing migrations
  • Run npm start to start the application.
  • Run npm test to run application tests.

Acknowledgments

  • Medium A great and educating blog I learnt a lot from.
  • StackOverflow My run to website in times of error and knowledge test.
  • Github For making it easy for me to get access to my repositories anywhere, anytime. Thanks!!!!
  • Scotch For all the awesome tutorials. Thanks!!!!

About

This is probably one of the smallest APIs ever written

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published