technoserve / caju-dashboard Goto Github PK

View Code? Open in Web Editor NEW

The Satellite Dashboard is a remote sensing dashboard created to map satellite growing areas in Benin.

License: MIT License

Python 28.24% HTML 13.91% CSS 28.91% JavaScript 2.41% SCSS 26.44% Dockerfile 0.04% Shell 0.04%

caju-dashboard's Introduction

Caju-Dashboard

The Satellite Dashboard is a remote sensing dashboard created to map satellite growing areas in Benin, using satellite imagery and machine learning algorithms. The dashboard will help field teams improve operations and policy makers make better decisions

Requirements (Prerequisites)

Tools and packages required to successfully install this project. For example:

Linux, Windows or MacOS
Python 3.9
MySQL database

Setup

The first thing to do is to clone the repository:

$ git clone https://github.com/TechnoServe/Caju-Dashboard-v2.git
$ cd Caju-Dashboard-v2

Create a virtual environment to install dependencies in and activate it:

$ python3 -m venv env
$ source env/bin/activate

Then install the dependencies:

(env)$ pip install -r requirements.txt

Note the (env) in front of the prompt. This indicates that this terminal session operates in a virtual environment set up previously.

Once pip has finished downloading the dependencies, run migrations with following command:

(env)$ python3 manage.py migrate --skip-checks

Then, create a .env file in the root of the project with following content:

TIMES=2

#Dashboard DB credentials
NAME='YOUR DATABASE NAME HERE'
USER='YOUR DATATBASE USERNAME HERE'
PASSWORD='YOUR DATABASE USER PASSWORD HERE'
HOST=YOUR DATABASE SERVER HOSTNAME HERE
PORT='YOUR DATABASE SERVER PORT HERE'

#CAJU-APP credentials
SQL_HOSTNAME=''
SQL_USERNAME=''
SQL_PASSWORD=''
SQL_DATABASE=''
SSH_HOSTNAME=''
SSH_USER=''

#SMTP
EMAIL_HOST='YOUR EMAIL SERVER HOSTNAME HERE'
EMAIL_HOST_USER='YOUR EMAIL ADDRESS HERE'
EMAIL_HOST_PASSWORD='YOUR EMAIL PASSWORD HERE'
EMAIL_PORT=YOUR EMAIL SERVER PORT HERE

#AWS
PKEY=''

#ALTEIA
ALTEIA_USER=""
ALTEIA_PASSWORD=""

#GOOGLE EARTH ENGINE
PRIVATE_KEY=""

#PROJECT SECRET KEY
SECRET_KEY="YOUR SECRET KEY HERE"

SERVER_URL="YOUR SERVER URL HERE. ex:http://127.0.0.1:8000/"