.gitignore

@@ -1 +0,0 @@
-venv

README.md

@@ -1,3 +1,48 @@
 # RightTree
 
 Right Plant Right Place Right Time implementation using React and Django.
+
+## Running application for development
+### Initial Setup
+
+Before running the applications please ensure the following prerequisites have been met.
+#### Software
+Most applications in this repository are built using Docker which resolves many dependencies but you will require a local installation of `git`, `docker` and `docker-compose`.
+
+```bash
+$ sudo apt install git docker-compose
+```
+
+To install `docker`, follow the [official installation documentation](https://docs.docker.com/get-docker/). [Instructions are also available for `docker-compose`](https://docs.docker.com/compose/install/).
+
+#### Initialise database
+
+Creates `right_tree` database and installs `postgis` extensions.
+
+```
+chmod +x ./database/init_database.sh
+./database/init_database.sh
+```
+
+#### Initial build
+
+Builds the Django backend docker image. This may need to be re-run if any new dependencies are added.
+```
+docker-compose build
+```
+
+### Run web application
+
+Starts up the applications including the frontend, backend and database.
+
+```
+docker-compose up
+```
+
+Once running the components can be accessed as follows:
+
+| Application | Hosted |
+| --- | --- |
+| React Frontend | http://localhost:3000 |
+| Django Backend | http://localhost:8000 |
+| Database | postgis://localhost:5432 |

backend/.gitignore

@@ -1,2 +1,3 @@
 *.pyc
 *.sqlite3
+__pycache__

backend/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.8-slim-bullseye
+
+ENV DJANGO_SUPERUSER_USERNAME=admin
+ENV DJANGO_SUPERUSER_EMAIL=admin@admin.com
+ENV DJANGO_SUPERUSER_PASSWORD=admin
+
+WORKDIR /app
+
+COPY ./requirements.txt /app/requirements.txt
+
+RUN pip install -U --no-cache-dir -r requirements.txt
+
+COPY . /app

backend/requirements.txt

@@ -0,0 +1,4 @@
+Django==3.2.8
+psycopg2-binary>=2.8
+djangorestframework==3.12.4
+django-cors-headers==3.10.0

backend/right_tree/api/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

backend/right_tree/api/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    name = 'right_tree.api'

backend/right_tree/api/migrations/0001_initial.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.2.8 on 2021-10-06 18:32
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Plant',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.TextField()),
+            ],
+        ),
+    ]

backend/right_tree/api/models.py

@@ -0,0 +1,4 @@
+from django.db import models
+
+class Plant(models.Model):
+    name = models.TextField()

backend/right_tree/api/serializers.py

@@ -0,0 +1,9 @@
+from rest_framework import serializers
+from right_tree.api.models import Plant
+
+class PlantSerializer(serializers.HyperlinkedModelSerializer):
+    id = serializers.ReadOnlyField()
+
+    class Meta:
+        model = Plant
+        fields = ['id', 'name']

backend/right_tree/api/views.py

@@ -0,0 +1,10 @@
+from rest_framework import viewsets
+from right_tree.api.models import Plant
+from right_tree.api.serializers import PlantSerializer
+
+class PlantViewSet(viewsets.ModelViewSet):
+    """
+    API endpoint that allows hours to be grouped or edited.
+    """
+    queryset = Plant.objects.all()
+    serializer_class = PlantSerializer

backend/right_tree/settings.py

@@ -37,6 +37,11 @@ INSTALLED_APPS = [
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
+
+    'rest_framework',
+    'corsheaders',
+
+    'right_tree.api',
 ]
 
 MIDDLEWARE = [
@@ -47,6 +52,7 @@ MIDDLEWARE = [
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'corsheaders.middleware.CorsMiddleware',
 ]
 
 ROOT_URLCONF = 'right_tree.urls'
@@ -75,8 +81,12 @@ WSGI_APPLICATION = 'right_tree.wsgi.application'
 
 DATABASES = {
     'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': BASE_DIR / 'db.sqlite3',
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'right_tree',
+        'USER': 'postgres',
+        'PASSWORD': 'postgres',
+        'HOST': 'postgres',
+        'PORT': 5432,
     }
 }
 
@@ -123,3 +133,11 @@ STATIC_URL = '/static/'
 # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+
+CORS_ALLOWED_ORIGINS = [
+    'http://localhost:3000' # Update this for production
+]
+
+CORS_ALLOW_HEADERS = [
+    'access-control-allow-origin'
+]

backend/right_tree/urls.py

@@ -14,8 +14,16 @@ Including another URLconf
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.contrib import admin
-from django.urls import path
+from django.urls import path, include
+
+from rest_framework import routers
+from right_tree.api import views
+
+router = routers.DefaultRouter()
+router.register(r'plants', views.PlantViewSet)
 
 urlpatterns = [
     path('admin/', admin.site.urls),
+    path('', include(router.urls)),
+    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
 ]

database/init/001_init_righttree.sql

@@ -0,0 +1,6 @@
+CREATE DATABASE right_tree;
+
+\c right_tree
+CREATE EXTENSION IF NOT EXISTS postgis;
+GRANT ALL ON geometry_columns TO PUBLIC;
+GRANT ALL ON spatial_ref_sys TO PUBLIC;

database/init_database.sh

@@ -0,0 +1,3 @@
+docker-compose down --remove-orphans --volumes
+docker-compose up postgres | sed '/PostgreSQL init process complete; ready for start up./q'
+docker-compose down

docker-compose.yaml

@@ -0,0 +1,49 @@
+version: "3.8"
+
+volumes:
+  local-postgres-data:
+    name: local-postgres-data
+
+services:
+  django-backend:
+    restart: unless-stopped
+    build:
+      context: backend
+      dockerfile: Dockerfile
+    container_name: righttree-backend
+    depends_on:
+      - postgres
+    volumes:
+      - ./backend:/app
+    ports:
+      - "8000:8000"
+    command: bash -c "./manage.py makemigrations; 
+                      ./manage.py migrate; 
+                      ./manage.py createsuperuser --noinput;
+                      ./manage.py runserver 0.0.0.0:8000"
+
+  react-frontend:
+    image: node:16-alpine3.11
+    restart: unless-stopped
+    container_name: righttree-frontend
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./frontend:/app
+    working_dir: /app
+    command: sh -c "npm install; npm start"
+
+  postgres:
+    image: postgis/postgis:13-3.0
+    restart: unless-stopped
+    container_name: postgres
+    volumes:
+      - local-postgres-data:/var/lib/postgresql/data
+      - ./database/init:/docker-entrypoint-initdb.d
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_DB=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+  

frontend/package.json

@@ -3,12 +3,19 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
+    "@emotion/react": "^11.4.1",
+    "@emotion/styled": "^11.3.0",
+    "@mui/material": "^5.0.2",
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^11.2.7",
     "@testing-library/user-event": "^12.8.3",
+    "axios": "^0.22.0",
+    "bootstrap": "^5.1.2",
+    "node-sass": "^6.0.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-scripts": "4.0.3",
+    "reactstrap": "^8.10.0",
     "web-vitals": "^1.1.2"
   },
   "scripts": {

frontend/public/index.html

@@ -4,12 +4,10 @@
     <meta charset="utf-8" />
     <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <meta name="theme-color" content="#000000" />
     <meta
       name="description"
       content="Web site created using create-react-app"
     />
-    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
     <!--
       manifest.json provides metadata used when your web app is installed on a
       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
@@ -24,7 +22,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>React App</title>
+    <title>Right Tree</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

frontend/public/manifest.json

@@ -6,16 +6,6 @@
       "src": "favicon.ico",
       "sizes": "64x64 32x32 24x24 16x16",
       "type": "image/x-icon"
-    },
-    {
-      "src": "logo192.png",
-      "type": "image/png",
-      "sizes": "192x192"
-    },
-    {
-      "src": "logo512.png",
-      "type": "image/png",
-      "sizes": "512x512"
     }
   ],
   "start_url": ".",

frontend/public/robots.txt

@@ -1,3 +0,0 @@
-# https://www.robotstxt.org/robotstxt.html
-User-agent: *
-Disallow:

frontend/src/App.css

@@ -1,38 +0,0 @@
-.App {
-  text-align: center;
-}
-
-.App-logo {
-  height: 40vmin;
-  pointer-events: none;
-}
-
-@media (prefers-reduced-motion: no-preference) {
-  .App-logo {
-    animation: App-logo-spin infinite 20s linear;
-  }
-}
-
-.App-header {
-  background-color: #282c34;
-  min-height: 100vh;
-  display: flex;
-  flex-direction: column;
-  align-items: center;
-  justify-content: center;
-  font-size: calc(10px + 2vmin);
-  color: white;
-}
-
-.App-link {
-  color: #61dafb;
-}
-
-@keyframes App-logo-spin {
-  from {
-    transform: rotate(0deg);
-  }
-  to {
-    transform: rotate(360deg);
-  }
-}

frontend/src/App.js

@@ -1,23 +1,18 @@
-import logo from './logo.svg';
-import './App.css';
+import SamplePage from './pages/SamplePage';
+import { createTheme, ThemeProvider } from '@mui/material/styles';
 
 function App() {
+  const darkTheme = createTheme({
+    palette: {
+      mode: 'dark',
+    },
+  });
+
   return (
     <div className="App">
-      <header className="App-header">
-        <img src={logo} className="App-logo" alt="logo" />
-        <p>
-          Edit <code>src/App.js</code> and save to reload.
-        </p>
-        <a
-          className="App-link"
-          href="https://reactjs.org"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          Learn React
-        </a>
-      </header>
+      <ThemeProvider theme={darkTheme}>
+        <SamplePage />
+      </ThemeProvider>
     </div>
   );
 }

frontend/src/assets/styles/main.scss

@@ -0,0 +1,8 @@
+@import "./theme.scss";
+
+// Core styles here...
+.App {
+    font-family: $primary-font;
+    color: $text-color-primary;
+    background-color: $background-color-primary;
+}

frontend/src/assets/styles/theme.scss

@@ -0,0 +1,9 @@
+@import url('https://fonts.googleapis.com/css2?family=Poppins&display=swap');
+
+// COLOURS
+$background-color-primary: #000000;
+$text-color-primary: #ffffff;
+$biosphere-blue: #0071bcff;
+
+// FONTS
+$primary-font: 'Poppins', sans-serif;

frontend/src/components/Stepper.js

@@ -0,0 +1,78 @@
+import * as React from 'react';
+import Box from '@mui/material/Box';
+import Stepper from '@mui/material/Stepper';
+import Step from '@mui/material/Step';
+import StepLabel from '@mui/material/StepLabel';
+import Button from '@mui/material/Button';
+
+import LocationStep from './steps/Location'
+import SoilStep from './steps/Soil'
+import ResultsStep from './steps/Results'
+
+const steps = [
+    {'label': 'Select location', 'component': LocationStep },
+    {'label': 'Choose soil', 'component': SoilStep },
+    {'label': 'Choose habitat', 'component': SoilStep },
+    {'label': 'Select zone', 'component': SoilStep },
+    {'label': 'Project specifics', 'component': SoilStep },
+    {'label': 'Summary', 'component': SoilStep }
+];
+
+export default function StepperWizard(props) {
+  const [activeStep, setActiveStep] = React.useState(0);
+
+  const handleNext = () => {
+    setActiveStep((prevActiveStep) => prevActiveStep + 1);
+  };
+
+  const handleBack = () => {
+    setActiveStep((prevActiveStep) => prevActiveStep - 1);
+  };
+
+  const handleReset = () => {
+    setActiveStep(0);
+  };
+
+  let CurrentStep = activeStep >= steps.length ? steps[steps.length-1].component : steps[activeStep].component;
+
+  return (
+    <Box sx={{ width: '100%' }}>
+      <Stepper activeStep={activeStep}>
+        {steps.map((step, index) => {
+          return (
+            <Step key={step.label}>
+              <StepLabel>{step.label}</StepLabel>
+            </Step>
+          );
+        })}
+      </Stepper>
+      {activeStep === steps.length ? (
+        <React.Fragment>
+          <ResultsStep {...props} />
+          <Box sx={{ display: 'flex', flexDirection: 'row', pt: 2 }}>
+            <Box sx={{ flex: '1 1 auto' }} />
+            <Button onClick={handleReset}>Reset</Button>
+          </Box>
+        </React.Fragment>
+      ) : (
+        <React.Fragment>
+          <CurrentStep {...props} />
+          <Box sx={{ display: 'flex', flexDirection: 'row', pt: 2 }}>
+            <Button
+              color="inherit"
+              disabled={activeStep === 0}
+              onClick={handleBack}
+              sx={{ mr: 1 }}
+            >
+              Back
+            </Button>
+            <Box sx={{ flex: '1 1 auto' }} />
+            <Button onClick={handleNext}>
+              {activeStep === steps.length - 1 ? 'Finish' : 'Next'}
+            </Button>
+          </Box>
+        </React.Fragment>
+      )}
+    </Box>
+  );
+}

frontend/src/components/steps/Location.js

@@ -0,0 +1,13 @@
+import React from 'react'
+import { Container } from 'reactstrap';
+
+
+export default class Step1 extends React.Component {
+    render() {
+        return (
+            <Container className="pt-4">
+                <p>Please choose your location...</p>
+            </Container>
+        )
+    }
+}

frontend/src/components/steps/Results.js

@@ -0,0 +1,18 @@
+import React from 'react'
+import { Container, ListGroup, ListGroupItem } from 'reactstrap';
+
+
+export default class Step3 extends React.Component {
+    render() {
+        return (
+            <Container className="p-2">
+                <h5 className="pt-4">Plant List</h5>
+                <ListGroup>
+                    {this.props.plants.map(function (plant, i) {
+                        return <ListGroupItem key={i} >{plant.name}</ListGroupItem>;
+                    })}
+                </ListGroup>
+            </Container>
+        )
+    }
+}

frontend/src/components/steps/Soil.js

@@ -0,0 +1,13 @@
+import React from 'react'
+import { Container } from 'reactstrap';
+
+
+export default class Step2 extends React.Component {
+    render() {
+        return (
+            <Container className="pt-4">
+                <p >Sample step</p>
+            </Container>
+        )
+    }
+}

frontend/src/config.js

@@ -0,0 +1 @@
+export const API_URL = "http://localhost:8000";

frontend/src/index.css

@@ -1,13 +0,0 @@
-body {
-  margin: 0;
-  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
-    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
-    sans-serif;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-}
-
-code {
-  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
-    monospace;
-}

frontend/src/index.js

@@ -1,9 +1,12 @@
 import React from 'react';
 import ReactDOM from 'react-dom';
-import './index.css';
 import App from './App';
 import reportWebVitals from './reportWebVitals';
 
+// Styles
+import './assets/styles/main.scss';
+import 'bootstrap/dist/css/bootstrap.min.css';
+
 ReactDOM.render(
   <React.StrictMode>
     <App />

frontend/src/logo.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3"><g fill="#61DAFB"><path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/><circle cx="420.9" cy="296.5" r="45.7"/><path d="M520.5 78.1z"/></g></svg>

frontend/src/pages/SamplePage.js

@@ -0,0 +1,44 @@
+import React from 'react'
+import { Container } from 'reactstrap';
+import Stepper from '../components/Stepper'
+
+import PlantRepsostory from '../repository/PlantRepository'
+
+export default class SamplePage extends React.Component {
+
+    constructor(props) {
+        super(props);
+
+        this.state = {
+            plants: []
+        }
+    }
+
+    updatePlants() {
+        PlantRepsostory.getPlants().then(response => {
+            if (response.status === 200) {
+                this.setState({ plants: response.data });
+            }
+        }).catch(e => {
+            this.setState({ plants: ["No plants found."] });
+        })
+    }
+
+    componentDidMount() {
+        this.updatePlants()
+    }
+
+    render() {
+        return (
+            <Container className="p-2">
+                <h1>Right Tree</h1>
+                <h4>Right Plant Right Place Right Time</h4>
+
+                <div className="pt-4">
+                    <Stepper plants={this.state.plants} />
+                </div>
+            </Container>
+        )
+    }
+
+}

frontend/src/repository/PlantRepository.js

@@ -0,0 +1,11 @@
+import Repository from "./Repository";
+
+const PlantRepsostory = {
+
+    getPlants() {
+        return Repository.get(`/plants/`);
+    }
+
+}
+
+export default PlantRepsostory;

frontend/src/repository/Repository.js

@@ -0,0 +1,14 @@
+import axios from "axios"
+import { API_URL } from "../config";
+
+// Base URL used by all requests
+const baseUrl = API_URL;
+
+// Create the axios object
+const repo = axios.create({
+    baseURL: baseUrl,
+});
+
+repo.defaults.headers.post["access-control-allow-origin"] = "*";
+
+export default repo;