/basic_authentification_backend

Primary LanguageJavaScript

Authentication

This repository contains ExpressJS API's based backend code that can be used to add and get a report of a market/mandi.

👨🏻‍🔬 Set up and run The Server

📃 Clone

Clone the repository from GitHub.

$ git clone https://github.com/PriyanshuRj/auth_backend.git

📂 Create your .env file

  1. After cloning the project navigate to the project directory using cd marketplace command.
  2. Generate .env in the directory.
  3. Add parameter to the env file.

Following parameters are required :

Variable Name Description
DB Path to a local mongo DB session.
EMAIL_USEREMAIL Email that sends the OTP mail to the users.
EMAIL_PASSWORD Password to the above that sends the OTP mail to the users.
PORT Port at which the backend will run if not defined default is 8000.
TWILIO_ACCOUNT_SID Account SID from your twilio account for mobile notifcation messages.
TWILIO_AUTH_TOKEN Twilio authentification token.
TWILIO_MOBILE_NUMBER Dummy mobile number provided by twilio.
JWT_SECRET Secret for encrypting JWT tokens.
SESSION_SECRET Sectret for encrypting session tokens.

An example .env file looks like :

DB=mongodb://localhost:27017/authlog
EMAIL_USEREMAIL=priyanshuauth@gmail.com
EMAIL_PASSWORD=Priyanshu@1234
PORT=5000
TWILIO_ACCOUNT_SID=JHGHIYTR876R68FT7RXTCY
TWILIO_AUTH_TOKEN=oiy87tvr67vt7trv6uyvyubdbdytufgvut
TWILIO_MOBILE_NUMBER=+13145627109
JWT_SECRET=oujhi77ub89u8ui
SESSION_SECRET=khjgiy6t86ybf8y

💻 Install Dependencies and Run the Server

$ npm install
$ npm run start

Now, use you can use the use the API's and try them out.

⚙️ Specification

/signup POST

This endpoint can be used to register a new user.

POST https://localhost:8000/signup HTTP/1.1
Content-type: application/json;

{
    "username":"string",
    "password":"string",
    "mobileno":"number",
    "email":"string"
}

Response:
{
    "message": "User created !!",
}

/login POST

This endpoint can be used to login a old user.

POST https://localhost:8000/login HTTP/1.1
Content-type: application/json;

{
    "email":"string"
    "password":"string",
}

Response:
{
    "message": "Successfully loged in",
    "token": "lkhut7tb8y8ybn08t78tjkbj89guh"
}

/otpverify POST

This endpoint can be used to login a old user.

POST https://localhost:8000/otpverify HTTP/1.1
Content-type: application/json;

{
    "email":"string"
    "otp":"number",
}

Response:
{
    "message": "OTP is correct !!",
}

/requestotp POST

This endpoint can be used to login a old user.

POST https://localhost:8000/requestotp HTTP/1.1
Content-type: application/json;

{
    "email":"string"
}

Response:
{
    "message": "OTP send successfully !!",
}