Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/api-server-nodejs
Nodejs API Server - Express / SQLite / TypeORM | AppSeed
https://github.com/app-generator/api-server-nodejs
api-node api-nodejs appseed appseed-sample node-api node-api-base node-application node-oauth node-starter node-starter-kit node-template nodejs nodejs-api nodejs-server nodejs-starter-kit nodejs-starter-template typeorm
Last synced: about 2 months ago
JSON representation
Nodejs API Server - Express / SQLite / TypeORM | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/api-server-nodejs
- Owner: app-generator
- License: other
- Created: 2019-07-03T19:41:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T10:29:27.000Z (9 months ago)
- Last Synced: 2024-07-05T13:23:45.371Z (2 months ago)
- Topics: api-node, api-nodejs, appseed, appseed-sample, node-api, node-api-base, node-application, node-oauth, node-starter, node-starter-kit, node-template, nodejs, nodejs-api, nodejs-server, nodejs-starter-kit, nodejs-starter-template, typeorm
- Language: TypeScript
- Homepage: https://appseed.us/boilerplate-code/nodejs-starter/
- Size: 255 KB
- Stars: 223
- Watchers: 8
- Forks: 87
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Nodejs API Server](https://appseed.us/product/soft-ui-dashboard/api-server-nodejs/react/)
[Express/Nodejs Starter](https://appseed.us/product/soft-ui-dashboard/api-server-nodejs/react/) with `JWT Authentication`, OAuth (Github), and **SQLite** persistence - Provided by `AppSeed`. Authentication Flow uses `json web tokens` via Passport library - `passport-jwt` strategy.
> 👉 [Support](https://appseed.us/support/) via **Discord & Email** provided by `AppSeed`.
## Features
- 🚀 `Full-stack ready` with [React Soft Dashboard](https://appseed.us/product/soft-ui-dashboard/api-server-nodejs/react/)
- ✅ Simple, intuitive codebase - can be extended with ease.
- ✅ `TypeScript`, `Joy` for validation
- ✅ **Stack**: NodeJS / Express / SQLite / TypeORM
- ✅ Auth: Passport / `passport-jwt` strategy
- 🆕 `OAuth` for **Github**
> Tested with:
| NodeJS | NPM | YARN |
| --- | --- | --- |
| `v18.0.0` | ✅ | ✅ |
| `v16.10.0` | ✅ | ✅ |
| `v14.15.0` | ✅ | ✅ |
## ✨ Requirements
- [Node.js](https://nodejs.org/) >= v16.13
- [SQLite](https://www.sqlite.org/index.html)
## ✨ How to use the code
> 👉 **Step 1** - Clone the project
```bash
$ git clone https://github.com/app-generator/api-server-nodejs.git
$ cd api-server-nodejs
```
> 👉 **Step 2** - Install dependencies via `Yarn`
```bash
$ npm i
// OR
$ yarn
```
> 👉 **Step 3** - Run the SQLite migration via TypeORM
```
$ npm run typeorm migration:run
// OR
$ yarn typeorm migration:run
```
> 👉 **Step 4** - Edit the `.env` using the template `.env.sample`.
```env
PORT=5000 # API PORT
SQLITE_PATH=./database.db # Path to the SQLite database file
SECRET="Whatever-STRONG" # Secret for sensitive data hashing
# Same as for React APP
GITHUB_OAUTH_CLIENT_ID= ... # Github OAuth secret
GITHUB_OAUTH_CLIENT_SECRET= ... # Github OAuth secret
```
> 👉 **Step 5** - Start the API server (development mode)
```bash
$ npm run dev
// OR
$ yarn dev
```
> 👉 **Step 6** - Production Build (files generated in `build` directory)
```bash
$ yarn build
```
> 👉 **Step 7** - Start the API server for production (files served from `build/index.js`)
```bash
$ yarn start
```
The API server will start using the `PORT` specified in `.env` file (default 5000).
## ✨ Codebase Structure
```bash
< 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:
```bash
$ yarn typeorm migration:generate -n your_migration_name
```
> 👉 Run migration:
```bash
$ yarn typeorm migration:run
```
## ✨ API
For a fast set up, use this POSTMAN file: [api_sample](https://github.com/app-generator/api-server-nodejs-pro/blob/master/media/api.postman_collection.json)
> 👉 **Register** - `api/users/register`
```
POST api/users/register
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"
}
```
## ✨ Update role for existing user
> 👉 Using npm:
```$ npm run update-role [user_id] [role_id (optional)]```
> 👉 Using yarn:
```$ yarn update-role [user_id] [role_id (optional)]```
- [user_id] is the id of existing user to update role for.
- [role_id] is the id of role: 1 for admin & 2 for user. If you don't provide any role_id it would update user to admin role.
## ✨ Run the Tests (`minimal suite`)
```
$ npm run test
// OR
$ yarn test
```
## ✨ Credits
This software is provided by the core AppSeed team with an inspiration from other great NodeJS starters:
- Initial verison - coded by [Teo Deleanu](https://www.linkedin.com/in/teodeleanu/)
- [Hackathon Starter](https://github.com/sahat/hackathon-starter) - A truly amazing boilerplate for Node.js apps
- [Node Server Boilerplate](https://github.com/hagopj13/node-express-boilerplate) - just another cool starter
- [React NodeJS Argon](https://github.com/creativetimofficial/argon-dashboard-react-nodejs) - released by **Creative-Tim** and [ProjectData](https://projectdata.dev/)
---
**[Node JS API Server](https://appseed.us/boilerplate-code/nodejs-starter/)** - provided by AppSeed [App Generator](https://appseed.us)