rodgercodes / opendatamalawi-backend

This is a platform where individuals can upload and get access to public datasets for the country

OpenDataMalawi

This is a platform where individuals can upload public datasets for the country that could be accessed via an api to download csv and excel files to train models.

Tech Stack

Docker (Optional)

Server: Django, Postgres

Run Locally

Clone the project

  git clone https://github.com/RodgerCodes/OpenDataMalawi-backend

Go to the project directory

  cd OpenDataMalawi-backend

create a .env

  make setup

Note Add the required env varibles values

Create a virtual environment

Install packages

  pip install -r requirements.txt

Run Migrations

  python manage.py migrate

Run Server

  python manage.py migrate

the api run on - http://localhost:8000

To view the docs visit

http://localhost:8000/api/schema/swagger-ui/

With Docker

Clone the project

  git clone https://github.com/RodgerCodes/OpenDataMalawi-backend

Go to the project directory

  cd OpenDataMalawi-backend

create a .env

  make setup

Note Add the required env varibles values

build the image

   make docker-build

start container

   make dev-start

navigate to containter shell

   make docker-shell

In docker shell run migrations

   python manage.py migrate

the api run on - http://localhost:8000

To view the docs visit

http://localhost:8000/api/schema/swagger-ui/

Running Tests

TODO: add tests

Contributions

As usual PRs are welcome.

opendatamalawi-backend's Issues

Design explore dataset page

A need for a design for the explore dataset pages ui

CRUD for dataset

create search results page

create a dashboard page

• route protection
• add a new dataset page
• edit user profile
• delete user account
• edit dataset
• delete dataset

Create a landing page

Create a landing page with a single search form

Design view single dataset page

search for datasets api end point

filter datasets by field api end point

Create account pages

• create login page
• create register page