elektropay / api-server-nodejs-pro

Nodejs API Server - Express / SQLite / MongoDB | AppSeed

Nodejs API Server PRO

Express / Nodejs Starter with JWT authentication, and SQLite or MongoDB persistance - Provided by AppSeed App Generator. Authentication flow uses json web tokens via Passport library - passport-jwt.

Features:

• API Definition - the unified API structure implemented by this server
• Simple, intuitive codebase - can be extended with ease.
• Typescript
• Data validation with Joy
• Branches:
  • Master: NodeJS / Express / SQLite / TypeORM
  • Mongo: NodeJS / Express / MongoDB / Mongoose
• Auth: Passport / passport-jwt strategy
• Unitary tests, Docker

Free Version available: SQLite persistance, Unitary Tests, 24/7 LIVE Support via Discord

Can be used with other React Starters for a complete Full-Stack experience:

React Node JS Berry	Full-Stack Material PRO	React Node Datta Able

Requirements

• Node.js >= 10.x
• SQLite - used by master branch
• MongoDB server - used by mongo branch

How to use the code

Step #1 - Clone the project (private repository)

$ git clone https://github.com/app-generator/priv-api-server-nodejs.git
$ cd priv-api-server-nodejs

Step #2 - Install dependencies via NPM or Yarn

$ npm i
// OR
$ yarn

Step #3 - Run the SQLite migration via TypeORM

$ yarn typeorm migration:run

Step #4 - Start the API server (development mode)

$ npm dev
// OR
$ yarn dev

Step #5 - Production Build (files generated in build directory)

$ npm build
// OR
$ yarn build

Step #6 - Start the API server for production (files served from build/index.js)

$ npm start
// OR
$ yarn start

The API server will start using the PORT specified in .env file (default 5000)

Codebase Structure

< ROOT / src >
     | 
     |-- config/                              
     |    |-- config.ts             # Configuration       
     |    |-- passport.ts           # Define Passport Strategy             
     | 
     |-- migration/
     |    |-- some_migration.ts     # database migrations
     |
     |-- models/                              
     |    |-- activeSession.ts      # Sessions Model (Typeorm)              
     |    |-- user.ts               # User Model (Typeorm) 
     | 
     |-- routes/                              
     |    |-- users.ts              # Define Users API Routes
     | 
     | 
     |-- index.js                     # API Entry Point
     |-- .env                       # Specify the ENV variables
     |                        
     |-- ************************************************************************

SQLite Path

The SQLite Path is set in .env, as SQLITE_PATH

Database migration

generate migration:

$ yarn typeorm migration:generate -n your_migration_name

run migration:

$ yarn typeorm migration:run

API

For a fast set up, use this POSTMAN file: api_sample

Register - api/users/register

POST api/users/signup
Content-Type: application/json

{
    "username":"test",
    "password":"pass", 
    "email":"[email protected]"
}

Login - api/users/login

POST /api/users/login
Content-Type: application/json

{
    "password":"pass", 
    "email":"[email protected]"
}

Logout - api/users/logout

POST api/users/logout
Content-Type: application/json
authorization: JWT_TOKEN (returned by Login request)

{
    "token":"JWT_TOKEN"
}

Credits

This software is provided by the core AppSeed team with an inspiration from other great NodeJS starters:

• Initial verison - coded by Teo Deleanu
• Hackathon Starter - A truly amazing boilerplate for Node.js apps
• Node Server Boilerplate - just another cool starter
• React NodeJS Argon - released by Creative-Tim and ProjectData

---

Nodejs API Server PRO - provided by AppSeed App Generator