README.md

snapnet

Application Features

snapnet is a car pooling application.

Table of Contents

• Technologies
• Features
• API Endpoints
• Getting Started
  • Installation
  • Testing
  • Development

API DeploymeUserUsernt (Non-Persistent)

API is deployed at https://snapnet-app-v1.herokuapp.com/

Technologies

• NodeJS - Runtime Environment
• ExpressJs - Web Application Framework
• MongoDB - Database

Features

Users

• Create an account
• Login into your account
• Create a citizen
• View all citizens
• View a particular citizen

API Endpoints

HTTP VERB	ENDPOINT	FUNCTIONALITY
Users
POST	/register	User Register
POST	/login	User Register
POST	/citizens	Only registered users can create a citizen
GET	/citizens	View all citizens
GET	/citizens/:citizenId	View a particular citizen

Getting Started

Installation

• git clone [snapnet]https://github.com/marufdeen/snapNet)
• Run yarn install or npm install to install packages
• Run yarn run seed or npm run seed to automatically seed admin into the database
• Run yarn run dev or npm run dev to start the server
• Navigate to localhost:8080 in browser to access the application

Testing

Data

• User Creation

 {
 name: String,
 email: String,
 password: String, 
}

• Citizen Creation

 {
 name: String,
 gender: String,
 address: String, 
 phone: String,
 ward_id: Numner 
}

Prerequisites

• Postman - API Toolchain

Testing with Postman

• After installing as shown above
• Navigate to localhost:8080 in Postman to access the application
• Super-admin login details ( {email: admin@dervac.com, password: admin} )