# base-nodejs-api

**Repository Path**: nickdoth/base-nodejs-api

## Basic Information

- **Project Name**: base-nodejs-api
- **Description**: Base Node.js Framework for building APIs
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-06-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Demo API Server

[API Specification](./docs/api-spec.md)

## Install & Start Server

Before you can start:

1. Copy config.example.json and rename the copied file to `config.json`.
2. Make sure `mongod` is running before calling `npm start`.

```shell
# Install PM2 (optional)
npm install pm2 -g

# Install Dependencies
npm install

# Start Server
node bin/server
```

## Add CMS Admin User

```sh
tsc && node bin/standalone add-admin 'admin@example.com' 'password'
```