Readme

Installation guide.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

Backend server using Express Framework to :

• User registration
• User login
• User can search user list data

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Node.js
• Express
• PostgreSQL
• JWT
• pg
• uuid
• yup
• Heroku

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites(Linux)

This is an example of how to list things you need to use the software and how to install them.

• npm

  sudo apt install npm

• nodejs

  sudo apt-get install nodejs

Installation

1. Clone the repo

   git clone https://github.com/Kshubhranshu/antarticaG.git

2. Install NPM packages

   npm install

3. Setup .env

   create a .env file in project directory
   copy environment variables from env-example to .env
   

4. Start the server

   npm start

Usage

Here is the postman api collention in order to access the api directly from postman postman-api-collection

• heroku backend server base url https://antarctica-g.herokuapp.com/api/v1

Folder Structure

|-- Procfile
|-- README.md
|-- auth (authentication module: login, register)
|   |-- dao.js
|   |-- index.js
|   `-- service.js
|-- common (common module: contains configuration variables and utility functions)
|   |-- appConfig.js
|   |-- db
|   |   `-- db_schema.sql
|   |-- dbConfig.js
|   `-- util.js
|-- dto (dto module: contains req body validation schemas)
|   `-- models.js
|-- env-example
|-- middleware (middleware module: contains validator for dto schemas)
|   `-- validate-dto.js
|-- package-lock.json
|-- package.json
|-- routes.js
|-- routesWithoutAuth.js
|-- server.js
`-- user-list (user-list module: search user list)
    |-- dao.js
    |-- index.js
    `-- service.js