Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 1.71 KB

README.md

File metadata and controls

62 lines (36 loc) · 1.71 KB

Bloomen developer portal app

Installation

  1. Go to project folder and install dependencies:
npm install
  1. Launch development server, and open localhost:3000 in your browser:
cp .env.example .env.development
-- fill .env.development with development configuration. 
npm start

Main tasks

Task automation is based on NPM scripts.

Task Description
npm start Run development server on http://localhost:3000/

Database

The example codebase uses Typeorm with a mongodb database.

NPM scripts

  • npm start - Start application
  • npm run build - Build application

API Specification

This application adheres to the api specifications set by the Thinkster team. This helps mix and match any backend with any other frontend without conflicts.

Full API Spec

More information regarding the project can be found here https://github.com/gothinkster/realworld

Start application

  • npm start
  • Test api with http://localhost:3000/api/docs in your favourite browser

Authentication

This applications uses JSON Web Token (JWT) to handle authentication. The token is passed with each request using the Authorization header with Token scheme. The JWT authentication middleware handles the validation and authentication of the token. Please check the following sources to learn more about JWT.