yegon-gk / Ajali-Full-Stack-App

Phase-5-Team-Ajali-Project

---

Collaborators

Yegon ~ Scrum Master

Nellius Wandia ~ Front-End

Michael Owiti ~ Front-End

Elijah Njora ~ Back-End

Nehema Kinya ~ Back-End

---

Table of Content:

1. Description.
2. Project Setup.
3. Technology Used.
4. Installation Requirements.
5. How to run & test this app.
6. License.

Description:

Ajali is an application developed by a team of professional software engineers designed to revolutionize emergency response. Utilizing React JS for the frontend, Python, Flask, SQL, and SQLite3 for the backend and database, Ajali streamlines the emergency reporting process, ensuring prompt assistance when needed.

With Ajali, users can seamlessly sign up and log in within seconds, enabling them to quickly report incidents. The application automatically captures the geolocation of the incident location, eliminating the need for manual input. Upon submission, administrators receive real-time notifications, allowing them to swiftly assess the situation and dispatch appropriate resources.

Ajali's robust technology stack ensures seamless operation, rapid incident reporting, and efficient emergency response coordination, making it an invaluable tool for communities seeking enhanced safety and well-being.

---

Backend Github Repository:

• https://github.com/KIPROTYCH/Phase-5-Team-Ajali-Back-End.git

Tables Diagram & Relationships:

• https://dbdiagram.io/d/Team-Ajali-653bdbe3ffbf5169f099ce36

Figma Design:

• https://www.figma.com/file/vjFlsIfdJwv4rDfotddYFq/Team-Ajali?type=design&node-id=0-1&mode=design&t=U0xYDESKQbVXp1vK-0

Presentation Google Slides:

• https://docs.google.com/presentation/d/1v_s8RYaGzMdR7IFhOP9JiZf9zyUA7lT7_B3CFddnD7w/edit#slide=id.g11daacbd15b_0_88

---

Project Setup:

Installation Requirements:

1. A Functional Laptop.
2. A good internet connection.
3. VS Code.
4. GitHub Account.

---

Technology Used:

Ubuntu:

A widely used open-source operating system based on Linux, known for its user-friendly interface and community-driven development.

VS CODE:

A source code editor that offers a wide range of features for developers, including debugging, extensions, and customization options.

Github:

A web-based platform where developers can store, manage, and share their code repositories and collaborate on projects among developers worldwide.

Python:

A high-level, interpreted programming language known for its simplicity, readability, and versatility. It emphasizes clean code and supports multiple programming paradigms, including object-oriented and functional programming.

Flask:

Flask is a micro web framework for Python, used to build web applications and APIs with simplicity and flexibility.

SQL:

SQL (Structured Query Language) is a standardized language used to manage relational databases. It allows users to create, read, update, and delete data in a database.

SQLITE:

SQLite3 is a lightweight, self-contained, embeddable relational database management system (RDBMS) that implements the SQL language. It is frequently used in applications that require embedded storage and is compatible with Python.

---

How to Run this Application:

Need a Terminal (Mac or Linux) or Command Prompt(Windows) Good Internet Connection.

* Clone the repository.

  $ git clone https://github.com/KIPROTYCH/Phase-5-Team-Ajali-Front-End.git
  $ cd team ajali
  $ npm install
  $ npm run dev
  $ cd server
  $ flask run

---

How to Test this Application:

• You can test the fucntionality of our Robust API using postman.

Bugs:

None at the moment, but would love to hear your feedback!

---

License:

This Project is under the MIT license

---