https://github.com/marvinkweyu/tambua-shamba

Understanding the health of a farm based on soil organic carbon.
https://github.com/marvinkweyu/tambua-shamba

agriculture geospatial geospatial-analysis geospatial-visualization mapping soil soil-properties

Last synced: about 1 month ago
JSON representation

Understanding the health of a farm based on soil organic carbon.

• Host: GitHub
• URL: https://github.com/marvinkweyu/tambua-shamba
• Owner: MarvinKweyu
• License: mit
• Created: 2023-01-17T03:14:07.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-11T17:17:40.000Z (almost 2 years ago)
• Last Synced: 2024-01-28T16:33:53.389Z (10 months ago)
• Topics: agriculture, geospatial, geospatial-analysis, geospatial-visualization, mapping, soil, soil-properties
• Language: JavaScript
• Homepage: https://www.marvinkweyu.net/projects/tambua_shamba
• Size: 33.4 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: License

Awesome Lists containing this project

README

        



  

  
Tambua Shamba

  
A project to collect and preview soil organic carbon performance in farms across Kenya 


>For an overview of what this product is about: [marvinkweyu/projects/tambua-shamba](https://www.marvinkweyu.net/projects/tambua_shamba)

![Tambua shamba](./preview/tambua-shamba-dashboard.png)

- [Local Development](#local-development)

- [Production environment(WIP)](#production-environmentwip)

- [Developer notes](#developer-notes)

- [Project improvements](#project-improvements)

## Local Development

Copy the docker environment variables from *.env.example* to *.env.dev*.

```bash

cp .env.example .env.dev

```

Copy project env variables 

```bash

cp .env.dev tambuashamba_server/tambuashamba/config/.env

```

To run the project in development mode, run the below at the root:

```bash

docker-compose up 

```

Access the client application on: **[127.0.0.1:4200](127.0.0.1:4200)** and the server-side application on **[127.0.0.1:8000/api/v1/docs](127.0.0.1:8000/api/v1/docs)**

Upload a file from the **test_files** directory to store and render farms onto the map

**To clean up the system**:

```bash

docker-compose down --volumes

```

## Production environment(WIP)

## Developer notes

## Project improvements

- [ ] Add authentication for specific users to access the resources.

- [ ] Intergration of asynchronous tasks. 

  Use celery and rabbitMQ to update farms from the CSV asynchronously.

- [ ] Download a file previously uploaded

- [ ] Paginate the files listed

- [ ] List and search for farms accepted under a specific file uploaded

- [ ] Search for a file by title or filter by date

- [ ] Search for a farm from the home page. The user should be able to zoom in on a farm with the name searched.