API for data collection app to measure proportion of urban population living in slums, informal settlements or inadequate housing
A data collection app to measure proportion of urban population living in slums, informal settlements or inadequate housing.
Data gaps across the African continent threaten to hinder the achievement of the Sustainable Development Goals and the African Union’s Agenda 2063. According to the United Nations, 68% of the SDG indicators lack data. This makes it difficult to measure progress on achievement of SDGs.The absence of high quality data on various indicators makes it difficult for policy makers and other stakeholders to plan and make informed decisions.
The number of people living in urban areas is rapidly increasing globally. However, cities and urban areas are not coping with the influx of people and the rate of urbanization. It is estimated that 1 billion people live in slums globally. Many countries do not have adequate data on the proportion of the population that live in slums who need adequate housing, which is a basic human right.
Our solution will therefore help to address SDG 17 and SDG 11, indicator 11.1.1: Proportion of urban population living in slums.
How would someone use what you have built, include URLs to the deployed app, service e.t.c when you have it setup
To setup this project on your computer, follow these steps:
- clone the repo onto your computer
- change directory to the project directory i.e
cd [project-folder] - create a
.envfile and copy and paste all the contents of the.env.examplefile into the new file. Change the following detailsdb_name- the name of the databasedb_user- the database userdb_password- the password of the database user
- run the following commands
composer install- to install all the dependencies.php artisan key:generate- to generate the application key (used for encryption).php artisan jwt:secret- to generate the secret key that will be used for creating auth tokens.php artisan migrate- to run the database migrations.
- to start the app, simply run
php artisan servefrom within the root of the project i.ecd [project-folder]php artisan serve
The API is hosted on Heroku and can be accessed from the following endpoint
https://b4sdg-team269.herokuapp.com/
| Type | Endpoint |
|---|---|
| POST | api/v1/auth/login |
| POST | api/v1/auth/logout |
| POST | api/v1/auth/refreshToken |
| POST | api/v1/auth/register |
| PUT | api/v1/auth/resetPassword |
| GET | api/v1/auth/user |
| GET | api/v1/user |
| GET | api/v1/users |
| POST | api/v1/users |
| GET | api/v1/users/{user} |
| PUT | api/v1/users/{user} |
| DELETE | api/v1/users/{user} |
| POST | api/v1/questions |
| GET | api/v1/questions |
| GET | api/v1/questions/{question} |
| PUT | api/v1/questions/{question} |
{
"email": "example@256.com",
"password": "password"
}php artisan test- to run all the testsphp artisan test --filter <test_name>- to run a particular test.composer lint- to run the lintercomposer lint:fix- to fix the lint errors
- Mentor: Lewis Tanguhwa
- TTL: Bright Onapito
- Product Manager: Henry Mutegeki
If this project sounds interesting to you and you'd like to contribute, thank you! First, you can send a mail to buildforsdg@andela.com to indicate your interest, why you'd like to support and what forms of support you can bring to the table, but here are areas we think we'd need the most help in this project :
- area one (e.g this app is about human trafficking and you need feedback on your roadmap and feature list from the private sector / NGOs)
- area two (e.g you want people to opt-in and try using your staging app at staging.project-name.com and report any bugs via a form)
- area three (e.g here is the zoom link to our end-of sprint webinar, join and provide feedback as a stakeholder if you can)
Add credits
- Devex
- Open Data Watch Report: Mapping Gender Data Availability in Africa
- TRENDS Report: Counting on the World to Act
MIT