https://github.com/saba-var/folksoul-api
Using the FolkSoul API you can add / modify / read / delete members, social links and band information
https://github.com/saba-var/folksoul-api
express jsonwebtoken mongodb mongoose nodejs swagger-ui typescript
Last synced: about 2 months ago
JSON representation
Using the FolkSoul API you can add / modify / read / delete members, social links and band information
- Host: GitHub
- URL: https://github.com/saba-var/folksoul-api
- Owner: Saba-Var
- Created: 2022-06-24T08:15:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-17T07:17:09.000Z (over 3 years ago)
- Last Synced: 2025-10-27T17:55:12.654Z (7 months ago)
- Topics: express, jsonwebtoken, mongodb, mongoose, nodejs, swagger-ui, typescript
- Language: TypeScript
- Homepage:
- Size: 3.54 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
FolkSoul API
Using the FolkSoul API you can add / modify / read / delete members, social links and band information
#
## Table of Contents
- [](#)
- [Table of Contents](#table-of-contents)
- [](#-1)
- [Prerequisites](#prerequisites)
- [](#-2)
- [Tech Stack](#tech-stack)
- [](#-3)
- [Getting Started](#getting-started)
- [](#-4)
- [Project Structure](#project-structure)
- [](#-5)
- [Resources](#resources)
#
## Prerequisites
- 
_Node JS @12.X and up_
- 
_npm @6 and up_
#
## Tech Stack
-
[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
#
## Getting Started
1\. First of all you need to clone repository from github:
```sh
git clone https://github.com/Saba-Var/folksoul-api.git
```
2\. Next step requires install all the dependencies
```sh
npm install
```
or
```sh
yarn install
```
3\. Copy .env
```sh
cp .env.example .env
```
4\. If you want you can also change default configuration of .env file and connect to mongodb
```sh
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:
```sh
npx tsc
```
6\. after that you can run FolkSoul API from terminal:
```sh
npm run dev
```
7\. To create new user from the terminal run the following command:
```sh
npm run user:create
```
To see swagger documentation visit [localhost:5001/api-docs](http://localhost:5001/api-docs)
#
## Project Structure
```bash
├─── readme
├─── src
│ ├── bin
│ ├── config
│ ├── controllers
│ ├── middlewares
│ ├── models
│ ├── routes
│ └── schemas
- .env
- .eslintrc.json
- .gitignore
- .prettierrc.json
- babel.config.json
- package.json
- README.md
- tsconfig.json
```
#
## Resources
- [Application Details](https://redberry.gitbook.io/assignment-iii-folksoul/)
- [Git commit rules](https://redberry.gitbook.io/resources/git-is-semantikuri-komitebi)