An open API service indexing awesome lists of open source software.

https://github.com/ibrsec/backend-stockapi

Backend of the Stock App
https://github.com/ibrsec/backend-stockapi

express jwt mongodb

Last synced: about 1 month ago
JSON representation

Backend of the Stock App

Awesome Lists containing this project

README

          








Logo

Stock App Backend


An awesome Backend project of Stock App





Backend Swagger
ยท
Backend Redoc
ยท
Frontend Repo
ยท
Report Bug
ยท
Request Feature


๐Ÿ“Ž Table of Contents ๐Ÿ“Ž


  1. About The Project


  2. Overview

  3. Quick Setup

  4. Directory structure

  5. Built With


---


## โ„น๏ธ About The Project

ERD:
[![stock-app-erd](./erdStockAPI.png)](https://backend-stockapi.onrender.com/)
---

(back to top)

---


## ๐Ÿ‘€ Overview

๐Ÿ“ฆ A Backend of Stock App Project
๐Ÿ€ [Frontend Repo](https://github.com/ibrsec/stockapp-frontend-selfservice)

๐ŸŽฏ Express.js Framework: Developed a robust RESTful API with Express.js for secure and efficient stock data management.

๐Ÿ”’ Authentication & Authorization: Implemented Simple Token, JWT for secure user authentication.

๐Ÿ“„ API Documentation: Created clear API docs with Swagger and Redoc for easy testing and understanding.

๐Ÿ“Š Database Management: Utilized MongoDB and Mongoose for consistent data modeling and querying.

๐Ÿ”„ CRUD Operations: Built full CRUD functionality for products, sales, purchases, firms, and brands.

๐Ÿ›  Middleware & Error Handling: Added custom middleware for validation and consistent error handling.

๐ŸŒ Scalable Deployment: Deployed on Render platform for high availability.

(back to top)


## ๐Ÿ›ซ Quick Setup

```sh
# clone the project
git clone https://github.com/ibrsec/backend-stockapi.git

# enter the project directory
cd backend-stockapi

# install dependency
npm install

# develop
npm run start

```

(back to top)


## ๐Ÿ“‚ Directory structure

```diff
+ backend-stockapi (folder)
+ |---src (folder)
| |---config (folder)
| |
| |---controllers (folder)
| |
| |---errors (folder)
| |
| |---middlewares (folder)
| |
| |---helpers (folder)
| |
| |---models (folder)
| |
| โ””---routes (folder)
|
|----.env
|----.gitignore
|----index.js
|----package.json
|----package-lock.json
|----swaggerAutogen.js
|----vercel.json
โ””----readme.md
```

(back to top)

---


### ๐Ÿ—๏ธ Built With































(back to top)