Faculty Profile Management System

---

Description

---

Faculty Profile Management System is a web based application for managing Faculty Information in a centralizd way and to generate reports based on those data and give visual analytis for the same. The web app is fully mobile frindly and is supported on all devices

Techonlogies

---

• Frontend :
• Backend :
• Database :

Getting Started

---

Installation

Note

Node must be installed on your device Make sure you have typescript installed on your device if not run the following command on your terminal

npm i -g typescript

Clone the project

git clone 'https://github.com/trushildhokiya/fpms.git'

Go to project directory

cd fpms

Setting up Frontend

Go to frontend directory and install dependencies

cd frontend
npm install

To run the frontend run the following command

npm run dev

Setting up Backend

Go to backend directory and install dependencies

cd backend
npm install

Create a env file with following fields

PORT = 5000
CONNECTION_STRING = <your mongodb connection string>
JWT_SECRET = any random bytes 
GMAIL_USER = <gmail account>
GMAIL_APP_KEY = < gmail app key >

To run the backend server run the following command

npm run dev # development server
npm start # prod server

Tip

To read backend documentation and try it run backend server and goto url

http://localhost:5000/api-docs