search

Ecell-NITS / e-cell-website-22-api

REST API of the official website of E-Cell NIT Silchar
GNU General Public License v3.0
0 stars 2 forks source link
express-js mongodb nodejs

readme

E-cell Website API

A brief description of what this project does and who it's for

Run Locally

Clone the project

  git clone https://github.com/Ecell-NITS/e-cell-website-22-api.git

Go to the project directory

  cd e-cell-website-22-api

Install dependencies

  pnpm i

Start the development server

  pnpm dev

API Reference

Home route

  GET /

Description: create account of the user

Response:

    Welcome to E-Cell website Backend API. Developed by E-Cell Tech Team.

Signup route

  POST /signup

Description: create account of the user

Parameter Type Description
name string Required. Full name
email string Required. Email for account creation
password string Required. A password that you can remember

Login route

  POST /signup

Description: login to user account

Parameter Type Description
email string Required. Email for account creation
password string Required. A password that you can remember

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

EMAIL_ECELL=Email address for sending mails

EMAIL_PWD_ECELL=password for email service

MONGODBSECRET=mongodb+srv://username:password@cluster0.gfrng.mongodb.net/db_name

NODE_VERSION= v18.x

YOUR_SECRET_KEY=A strong secret key for user authentication