Mapapi

Comprehensive solution for managing and visualizing environment-related incidents .

Developed with the software and tools below.

Table of Contents

• Overview
• Technologies
• Features
• System Architecture
• Setup
• Contribute to the project
• Authors
• Licensing
• Developer Documentation
• DPG Assessment

Overview

Mapapi (Map Action API) is a comprehensive solution that combines a robust API. This project is designed to manage and visualize environment-related incidents efficiently and effectively.

Technologies

• Django: Used to build the backend for Map Action mobile app and dashboard.
• Postgres: Used to store users data and incidents reported
• Celery: Used as an asynchronous task queue/job
• Redis: Used as a message broker for Celery and for caching.

Features

• API: Provides endpoints for managing and retrieving data on environment-related incidents.
• Asynchronous Task Processing: Uses Celery and Redis to handle background tasks efficiently.
• Database Management: Utilizes Postgres for robust data storage and querying capabilities.

System Architecture

Setup

Prerequisites

• Ensure you have Docker and Docker Compose installed on your system.

Clone the repository

git clone https://github.com/223MapAction/Mapapi.git
cd Mapapi

Build and run the containers

• Use Docker Compose to build and run the services defined in the _cd_pipeline.yml file.

docker-compose -f _cd_pipeline.yml up --build

• This command will build the Docker images and start the containers for the application, including the database, API server, Redis, and other services.

Access the application

• Once the containers are up and running, you can access the application at http://localhost.

Stopping the services

• To stop the running services, use:

docker-compose -f _cd_pipeline.yml down

This setup leverages Docker to manage dependencies and services, ensuring a consistent environment across different systems.

Contribute to the project

Map Action is an open source project. Fell free to fork the source and contribute with your features. Please follow our contribution guidelines.

Authors

Our code squad : A7640S, Yugo19 & immerSIR

Licensing

This project was built under the GNU Affero General Public License.

Developer Documentation

For more detailed information, please refer to the Developer Documentation.

DPG Assessment

For a detailed assessment of the project's compliance with the Digital Public Goods Standard, please see the DIGITAL PUBLIC GOODS STANDARD ASSESSMENT. This document outlines our alignment with sustainable development goals, open licensing, and more.

Note

if your system is Linux or MacOS, you have to add 3 on python example python3 manage.py runserver