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

Backend of a Personnel App
https://github.com/ibrsec/personnel_app-backend

express mongodb swagger token-authetication

Last synced: 2 months ago
JSON representation

Backend of a Personnel App

• Host: GitHub
• URL: https://github.com/ibrsec/personnel_app-backend
• Owner: ibrsec
• Created: 2024-07-26T20:35:38.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T12:38:25.000Z (almost 2 years ago)
• Last Synced: 2025-01-08T21:36:24.776Z (over 1 year ago)
• Topics: express, mongodb, swagger, token-authetication
• Language: JavaScript
• Homepage: https://personnel-app-backend.vercel.app/documents/swagger
• Size: 365 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          



  

 






   

  

    

  


  
Personnel App backend


  


    An awesome backend of the Personnel App application

    Explore the docs »

    


    


    .

    Backend Swagger

    ·

    Backend Re-doc

    ·

    Frontend Live Link?

    ·

    frontend Repo?

    ·

    Report Bug

    ·

    Request Feature

  



  📎 Table of Contents 📎 

  


    
About The Project

    
ERD

     

     
Overview

     
Quick Setup

     
Directory structure

     
Built With

    


    

  


---



## ℹ️ About The Project

 

[![personnel_app-backend](./src/assets/swagger.png)](https://personnel_app-backend.vercel.app/api-doc/)



## ℹ️ ERD

[![personnel_app-backend](./src/assets/erd.png)](https://personnel_app-backend.vercel.app/api-doc/)

(back to top)


---



## 👀 Overview

📦 Backend of the    Personnelapp-frontend project  for store data 

🎯 Used express, dotenv, express-async-errors,token authentication, mongoose, swagger-autogen, swagger-ui-express,cors,morgan, redoc-express  

🖥 MongoDb is used as db 

🔩 Token authentication is used for authorization and authentication operations 

🖥 Unauthorized user cant access anything.

 🔩 User can Register and login as personnel! 

🖥 After login, user can screen the details of the personnels and departments

🖥 For create modification operations needs a admin user and for be able to create a admin user you need to have the adminkey

🖥 All departments can have just one lead and, lead can list the personnels of the own deparment!

 

(back to top)




## 🛫 Quick Setup

```sh

# clone the project

git clone https://github.com/ibrsec/personnel_app-backend.git

# enter the project directory

cd personnel_app-backend

# install dependency

npm install 

# develop

npm run start 

```

(back to top)




## 📂 Directory structure 

```diff

+ personnel_app-backend  (folder)     

+     |---src (folder) 

      |     |---config (folder)       

      |     |           

      |     |---controllers (folder) 

      |     |    

      |     |---middlewares (folder)      

      |     |          

      |     |---helpers (folder)      

      |     |          

      |     |---models (folder)           

      |     |          

      |     └---routes (folder)  

      |      

      |----.env

      |----.gitignore

      |----index.js

      |----package.json

      |----package-lock.json

      |----swagger.json

      |----swaggerAutogen.js

      |----sync.js

      |----vercel.json

      └----readme.md 

```

(back to top)


---



### 🏗️ Built With

 

 

 

  

 

 

 

 

 

 

 

  

 

 

 

 

 

 

 

 

 

 

  

  

  

  

 

  

  

  

  

  

  

  

  

 

  

 

(back to top)