snapnet is a car pooling application.
API is deployed at https://snapnet-app-v1.herokuapp.com/
- Create an account
- Login into your account
- Create a citizen
- View all citizens
- View a particular citizen
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 |
- git clone [snapnet]https://github.com/marufdeen/snapNet)
- Run
yarn install
ornpm install
to install packages - Run
yarn run seed
ornpm run seed
to automatically seed admin into the database - Run
yarn run dev
ornpm run dev
to start the server - Navigate to localhost:8080 in browser to access the application
- User Creation
{
name: String,
email: String,
password: String,
}
- Citizen Creation
{
name: String,
gender: String,
address: String,
phone: String,
ward_id: Numner
}
- Postman - API Toolchain
- 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} )