esraa-alaarag / zootopia-api

The Government of Zootopia API : contains information about Zootopia citizins

Zootopia-API

Live:[Zootopia-API] (https://zootopia-api.herokuapp.com/

Table of Contents

1. App description
2. User Stories
3. Visual representation of the database
4. Pseudocode
5. Technologies used
6. Ways to see the project

APP DESCRIPTION:

Zootopia is an application for Zootopia Embassy that helps people who apply to renew their passport to track their passport renewal process.

This project consists of three parts:

1.Zootopia API:

This app works as Restful API to store all Zootopia citizens information and provide the embassy with detailed information on every citizen. This API provides.

• Basic CRUD (Create, Read, Update and Delete) with postman.

• Cross-origin Resource Sharing using by using CORS middleware.

Live demo: https://zootopia-api.herokuapp.com/

2.Embassy of Zootopia app:

This part is for the official use of the embassy staff. The embassy staff can import the applicant information from the government API and store it to the embassy database. they can add the date the application was received and update the status of the application and the date when the status was updated.

Also this part serve as API for Zootopia citizen APP. Zootopia citizen AP make axios get Request to this API to get the status of the application.

Live demo: https://embassy-of-zootopia.herokuapp.com/

3.Zootopia citizen APP:

A customized HTML template for the citizen of Zootopia to check the status of their passport renewal application.

Applicants can enter their social security number to check the status of their passport.

Live demo: https://esraa-alaarag.github.io/zootopia/

USER STORIES:

• As a user, I want to be able to view all the people’s information in the database
• As a user, I want to be able to view one person’s information using social security number.
• As a user, I want to be able to add a person to the database through postman.
• As a user, I want to the social security number to be unique and get error message if I want to add person with social security number that is already exist.
• As a user, I want to be able to change person’s information in the database through postman.
• As a user, I want to see the API instruction

PSEUDOCODE:

Creating Zootopia Government database

• Design tables, relations, primary keys and foreign keys for each table.
• Create schema file
• seed the database using the schema file
• Create government API using express and node.js with full crud functionality

  • Create: POST: add one citizen to the database using postman

  • Read: GET: get all citizens information or get one only by using the citizen’s social security number through the browser

  • Update: PUT change one citizen’s information using postman

  • Delete: DELETE one citizen from the database using social security number

ERD/VISUAL REPRESENTATION OF DATABASE:

TECHNOLOGIES USED:

Core Stack:

• Node
• Express
• PostgreSQL
• HTML
• CSS
• JavaScript
• jQuery
• Heroku
• Git

Middleware:

• nodemon
• pg-promise
• axios
• cors
• Bootstrap
• Morgan

Also

• Trello
• Postman (API and DB testing)
• Postico

SEE THE PROJECT:

Live Deployment of App: https://zootopia-api.herokuapp.com/

Download Project & Install

1. Git clone and download this project]
2. Create a PostgreSQL database called 'Zootopia'
3. On your terminal, run psql -d zootopia -f schema.sql
4. npm install
5. npm run dev, app should be available on localhost

Go Back to the Table of Content