> For the complete documentation index, see [llms.txt](https://appseed.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://appseed.gitbook.io/docs/boilerplate-code/api-server/node-js.md).

# API Server Node JS

Free API Server coded on top of Express / Node JS with **SQLite** persistence and JWT authentication via Passport library - `passport-jwt` strategy.

> Version: [**v1.0.1**](https://github.com/app-generator/api-server-nodejs/releases), release date `2022-06-02`

* [API Definition](/docs/boilerplate-code/api-server/api-unified-definition.md) - the unified API structure implemented by this server
* [Node JS API Server](https://github.com/app-generator/api-server-nodejs) - source code
* Full-stack samples compatible with this product:
  * [React Berry Dashboard](https://github.com/app-generator/react-berry-admin-template) - open-source sample
  * [React Datta Dashboard](https://github.com/app-generator/react-datta-able-dashboard) - open-source sample

> API Methods - for full description please access [API Unified Definition](/docs/boilerplate-code/api-server/api-unified-definition.md)

* USERS API:
  * `/api/users/register`: create a new user
  * `/api/users/login`: authenticate an existing user
  * `/api/users/logout`: delete the associated JWT token
  * `/api/users/checkSession`: check an existing JWT Token for validity
  * `/api/users/edit` - edit the information associated with a registered user

![Node JS API Server - Open-source Product.](/files/-MfOPM4Bs_KZcukS1TXw)

## ✨ Tests Matrix

| NodeJS     | NPM       | YARN       | Status |
| ---------- | --------- | ---------- | ------ |
| `v17.0.0`  | `v8.11.0` | `v1.22.18` | ✔️     |
| `v16.15.1` | `v8.11.0` | `v1.22.18` | ✔️     |
| `v16.13.0` | `v8.1.0`  | `v1.22.5`  | ✔️     |

## ✨ How to use the code

> 👉 **Step 1** - Clone the sources

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

> 👉 **Step 2** - Install dependencies via NPM or Yarn

```
$ npm i
// OR
$ yarn
```

> 👉 **Step 3** - Run the `SQLite` migration

```
$ 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 (production mode)

```
$ 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
```

## ✨ Compatible Fullstack Products

The product can be used as a standalone server but also as an authentication server for React, Vue products. Such a product already configured with Django API Server is [**React Datta Able**](https://appseed.us/product/datta-able/api-server-nodejs/react/)**,** an open-source React Dashboard.

* [React Datta Able](https://appseed.us/product/datta-able/api-server-nodejs/react/) - product page
* ​[React Datta Able](https://github.com/app-generator/react-datta-able-dashboard) - source code

![React Datta Able - Open-Source Dashboard.](https://gblobscdn.gitbook.com/assets%2F-MYVW6MKCi9iujNc3SK_%2F-Memyr3wdOIsonokJPUQ%2F-Men-RiulajMsyVGTEgy%2Freact-datta-able-cover.jpg?alt=media\&token=c87fbe5e-44b0-4d3d-9bb3-c41495fbb567)