https://github.com/tusho7/personal-portfolio-api
https://github.com/tusho7/personal-portfolio-api
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tusho7/personal-portfolio-api
- Owner: Tusho7
- Created: 2023-05-08T09:14:36.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-02T08:24:10.000Z (about 3 years ago)
- Last Synced: 2025-03-22T20:30:02.868Z (about 1 year ago)
- Language: JavaScript
- Size: 1010 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Personal Portfolio
### Table of Contents
- [Prerequisites](#Prerequisites)
- [Tech Stack](#Tech-Stack)
- [Getting Started](#Getting-Started)
- [Project Structure](#Project-Structure)
#
### Prerequisites
- 
Node JS @16.X and up
- 
npm @8 and up
#
### Tech Stack
- body-parser @ 1.20.0 - Node.js body parsing middleware
- 
dotenv @ 16.0.3 - zero-dependency module that loads environment variables from a .env file
- 
express @ 4.18.2 - web framework for node
- 
mongodb @ 4.13.0 - document database
- 
mongoose @ 6.9.1 - MongoDB object modeling tool
- 
swagger @ 4.6.0 - module provides tools for designing and building Swagger-compliant APIs entirely in Node.js
#
### Getting Started
1. First of all you need to clone app repository from github:
```
git clone https://github.com/Tusho7/personal-portfolio-api
```
2. Next step requires install all the dependencies.
```
npm install
```
3. Also you need to create .env file where copy information from .env.example file
```
cp .env.example .env
```
4. To create your own database, need to create new local connection, host would be localhost.
also you need to replace variables values in .env file, or you can generate mongo atlas url with user and password
#
### Project Structure
```
|--- src
| |--- config # configuration files
| |---|--- mongo.js # perform mongoDb connection
| |---|--- swagger.yaml # swagger configuration file
| |--- controllers # functions for routes
| |--- middlewares # extra helper middleware functions
| |---|--- swagger-middleware.js # function to build and serve swagger
| |--- models # mongoose models for mongoDb
| |--- routes # project routes
| |--- server.js # main file
- package.json # dependency manager configurations
```