irvinehawks/Electronic-passport-booking-application-system

A web based platform for the registra general's office of the Republic of Zimbabwe which facilitates the application of electronic passports by the eligible citzenry of the country.

Electronic application and booking web platform

Table of Contents

1. About The Project
   • Features
   • Built With
   • Users
2. Getting Started
   • Installation
   • Ports and EndPoints
3. Contributing

About The Project

MERN Stack Application for booking and applying for eletronic passports online

Features

• Login / Sign-up
• Edit user-data
• Add bookings or applications
• Browse user's applications with (search + filter) feature
• Display application-status + monthly-applications in graphs

Built With

• React
• React Router
• styled-components
• Node.js
• Express
• MongoDB

users

Email	Password
irvenehawks@gmail.com

Validation

• Email validation: as per RFC2822 standards.
• Password validation:
  • The password must be more than 6 characters.

(back to top)

---

Getting Started

This project require some perquisites and dependencies to be installed, you can find the instructions below

This project require some perquisites and dependencies to be installed, you can view it online using this [TBA]. or you can find the instructions below:

To get a local copy, follow these simple steps :

Installation

installing Locally

1. Clone the repo

   git clone..............

2. go to project folder

   cd <directory-name>

3. install dependencies

   npm run install

4. Environmental Variables Set up

   • Here are the environmental variables that needs to be set in the .env file in the server directory.
   • These are the default setting that I used for development, but you can change it to what works for you.

     PORT=5000
     MONGO_URL=<Your mongodb url>
     JWT_LIFETIME=1d
     JWT_SECRET=<any secret value of your choice>
   

5. Run development server

   npm start

---

Ports and EndPoints

Ports

• FrontEnd Development Server runs on port 3000
• BackEnd Development Server runs on port 5000

API endpoints

Main URL: http://localhost:5000/api/v1

• Auth

  • Register User: http://localhost:5000/api/v1/auth/register [POST]
  • Register User: http://localhost:5000/api/v1/auth/login [POST]
  • Update User: http://localhost:5000/api/v1/auth/updateUser [PATCH]

• Applications

  • Get all applications: http://localhost:5000/api/v1/jobs?status=all&jobType=all&page=1 [GET]
  • Create application or booking: http://localhost:5000/api/v1/jobs [POST]
  • Update aplication: http://localhost:5000/api/v1/jobs/:id [PATCH]
  • Delete application: http://localhost:5000/api/v1/jobs/:id [DELETE]
  • Get stats: http://localhost:5000/api/v1/jobs/stats [Get]

(back to top)

---

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)