MuhamedMagdi/LitFair-Server

LitFair-Server

Table of contents

• Project Title
• Prerequisite
• Table of contents
• Installation
• Services documentation

prerequisite

1. Nodejs
2. SQL
3. .env file

Installation

(Back to top)

• After cloneing the repo open the folder in cmd and run the following command to install all third part bakages

    > npm i
  

• Create .env file which have to include important parametarts :

  • PORT

  it should be like that :

   > PORT=3000
  

• Create SQL Database and name it sequelizedb

Finally to run the server

npm run devServer 

Services documentation

Service
User

User

This service is for add new users "either by google or normal sign up", provide authentication, and set JWT

Routes :

URL	Type
/adduser	post

/adduser

For add new user as a seeker the request body should contain the next values

Field	Description
email	required and unique
password	required
role	either "Seeker" or "Company"
fname	required for seekers
lname	required for seek