Using the FolkSoul API you can add / modify / read / delete members, social links and band information

• • Table of Contents
• • Prerequisites
• • Tech Stack
• • Getting Started
• • Project Structure
• • Resources

• 

  Node JS @12.X and up

• 

  npm @6 and up

• 

  [NodeJS @16.15.1] - JavaScript runtime built on Chrome's V8 JavaScript engine

• 

  [Express @4.18.1] - Fast, unopinionated, minimalist web framework for Node.js

• 

  [MongoDB] - Open source NoSQL database management program

• 

  [mongoose @6.3.6] - elegant mongodb object modeling for node.js

• 

  [Typescript @4.7.4] - TypeScript is JavaScript with syntax for types.

• 

  [Swagger UI Express @4.4.0] - Serve auto-generated swagger-ui generated API docs from express

1. First of all you need to clone repository from github:

git clone https://github.com/Saba-Var/folksoul-api.git

2. Next step requires install all the dependencies

npm install

or

yarn install

3. Copy .env

cp .env.example .env

4. If you want you can also change default configuration of .env file and connect to mongodb

MONGO_DATABASE=folksoul
MONGO_PROTOCOL=mongodb
MONGO_HOST=localhost
MONGO_PORT=27017
MONGO_CLUSTER=''

SERVER_PORT=5001

ACCESS_TOKEN_SECRET=secret-text

USER_PASSWORD=***
USER_EMAIL=***

5. For the first time before run the API run following command:

npx tsc

6. after that you can run FolkSoul API from terminal:

npm run dev

7. To create new user from the terminal run the following command:

npm run user:create

To see swagger documentation visit localhost:5001/api-docs

├─── readme
├─── src
│    ├── bin
│    ├── config
│    ├── controllers
│    ├── middlewares
│    ├── models
│    ├── routes
│    └── schemas
- .env
- .eslintrc.json
- .gitignore
- .prettierrc.json
- babel.config.json
- package.json
- README.md
- tsconfig.json

• Application Details
• Git commit rules