User-form

A form for collecting user information, and display the information

User Registration, User List and Detail page.
Explore the docs »
Report Bug

Table of Contents

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

About The Project

Simple Node.JS project where a user can register and able to view the registered users.

Here's why:

• Project that demonstrates the implementation of user registration
• List all the users which are saved in database
• Detail page where we list all the saved details of the user.

Built With

The project is built using Node.js, Express.js Framework, Mongodb.

• Node.js
• Express.js
• MongoDB
• Jest - Javascript Testing Framework

Getting Started

Follow the below instructions for setting up the project locally.

Prerequisites

• Node.js
• MongoDB

Installation

1. Clone the repo

   git clone https://github.com/libinthomas33/User-form.git

2. cd User-form
3. Install NPM packages

   npm install

4. Create .env file and fill the DB credentials.

    MONGO_HOST='ENTER YOUR MONGO HOST URL'
    MONGO_PORT='ENTER YOUR MONGO PORT'
    MONGO_DBNAME='ENTER YOUR MONGO DATABASE NAME'
    DEBUG_MODE=true

5. NB: DEBUG_MODE value should be changed to false, while going production or Testing API's using Jest
6. Install NPM packages

   npm start

7. For Testing API's, follow the below steps:-

       npm install --save-dev jest
       npm install --save-dev supertest

   Add the below script to the package.json file

       "scripts": {
           "test": "jest"
       }

       npm run test

Roadmap

See the open issues for a list of proposed features (and known issues).