Added files

Author: jbvogt

.github/workflows/backend-ci.yml

@@ -0,0 +1,30 @@
+name: Backend CI
+
+on:
+  push:
+    paths:
+      - 'backend/**'
+  pull_request:
+    paths:
+      - 'backend/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+
+    - name: Install Python dependencies
+      run: |
+        cd backend
+        pip install -r requirements.txt
+
+    - name: Run backend tests
+      run: |
+        cd backend
+        pytest

.github/workflows/frontend-ci.yml

@@ -0,0 +1,31 @@
+name: Frontend CI
+
+on:
+  push:
+    paths:
+      - 'src/**'
+  pull_request:
+    paths:
+      - 'src/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '14'
+
+    - name: Install npm dependencies
+      run: |
+        cd src
+        npm install
+
+    - name: Run frontend tests
+      run: |
+        cd src
+        npm test -- --coverage

.gitignore

@@ -0,0 +1,51 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+__pycache__/
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+.coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# custom
+.vscode
+/model/data/*
+!/model/data/geojson
+/model/inputs/
+.R*
+.vscode
+/backend/flask_session
+
+# Ignore data files
+data/*
+!data/png-images
+
+# Ignore all TIFFs
+*.tif
+
+# Ignore model input/output
+model/input
+model/output
+
+# Ignore all TeX files except .tex and .pdf
+/techdoc/*
+!techdoc/tech-doc.pdf
+!techdoc/tech-doc.tex
+backend/app/base.py

.here

@@ -0,0 +1,28 @@
+# Dockerfile for the front end of the application.
+
+# Start with the Node.js 18 Alpine image
+FROM node:18-alpine
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Copy package.json and package-lock.json (if available)
+COPY package*.json ./
+
+# Install dependencies listed in package.json
+# Include specific additional packages needed for the project
+RUN npm install && \
+    npm install d3 && \
+    npm install react-cookie && \
+    npm install leaflet react-leaflet leaflet-arrowheads leaflet-polylinedecorator && \
+    npm install --save-dev @testing-library/react @testing-library/jest-dom jest-fetch-mock && \
+    npm install --save-dev @testing-library/jest-dom
+
+
+
+# Copy the rest of the application
+COPY . .
+
+# The application is started with npm start
+# This should keep the container running as it launches the app
+ENTRYPOINT ["npm", "start"]

Dockerfile

@@ -0,0 +1,61 @@
+# Usage
+
+## Prerequisites
+
+Your terminal should be running commands in the root directory of this project.
+
+Ensure that your terminal supports both `pip` and `npm` commands.
+
+## Starting the backend
+```
+pip install -r backend/requirements.txt
+fastapi dev backend/app/base.py
+```
+  - Access docs by navigating to ```localhost:8000/docs``` on your web browser
+  - To run the backend for debugging purposes, run ```uvicorn backend.app.base:app --reload``` in your terminal.
+    - Note that this only runs the backend. It can not be navigated to on the web browser, nor will documentation be available.
+
+## Starting the frontend
+
+```
+npm install
+npm start
+```
+- These commands should install all required packages for the webpage, as well as start the frontend. The webpage should automatically open in your default browser under the tab "Birdmig".
+  - This process may take a few minutes.
+
+# To run Docker with all applications
+- Ensure that the Docker daemon is running
+  - Opening the Docker desktop app is the easiest way to ensure this step
+- Build and run the containers with the command: ```docker-compose up -d --no-deps --build```
+- Go to ```http://localhost:3000``` to observe changes.
+
+# Running React Tests
+This project uses [Jest](https://jestjs.io/) alongside [@testing-library/react](https://testing-library.com/docs/react-testing-library/intro) for testing React components.
+
+## Prerequisites
+
+Before running tests, make sure you have:
+
+- Node.js installed on your system.
+- All the project dependencies installed. If you haven't done so already, you can install them by running `npm install` in the project's root directory.
+
+## Running All Tests
+
+To run all the tests in the project, you can use the following command:
+
+```sh
+npm test
+```
+
+Running Tests with Coverage
+To run tests and generate a coverage report, you can use the following command:
+
+```sh
+npm test -- --coverage
+```
+This will not only test your components but also provide a detailed report of your test coverage.
+
+## Writing New Tests
+Test files are located alongside the components they are testing, with a `.test.js` or `.test.jsx` file extension. For example, if you have a component in `src/components/MyComponent.js`, its tests should be in `src/components/MyComponent.test.js`.
+

README.md

@@ -0,0 +1,34 @@
+# Use a Python base image
+FROM python:3.9-slim
+
+# Set the working directory in the container to /code
+WORKDIR /code
+
+# Install system dependencies for GEOS, pip, and building Python packages
+# Including gcc, musl-dev for compiling, and libgeos-dev for Shapely
+RUN apt-get update && \
+    apt-get install -y gcc musl-dev libgeos-dev
+
+# Install numpy first to avoid conflicts
+RUN pip install numpy
+RUN pip install scikit-learn
+
+# Copy the requirements.txt file to the container
+COPY requirements.txt .
+
+# Install dependencies listed in requirements.txt
+RUN pip install -r requirements.txt
+
+# Copy the entire backend directory to the container
+COPY . .
+
+# Ensure the data directory is properly copied
+COPY app/data/ /code/data/
+
+COPY app/models/ /code/models/
+
+# Expose the port the app runs on
+EXPOSE 8000
+
+# Command to run the application
+CMD ["fastapi", "dev", "base.py"]

backend/Dockerfile

@@ -0,0 +1,10 @@
+# Running Tests:
+Write all tests for the backend in the ```tests``` directory.
+
+With pytest installed, you can run tests from the command line with the following command:
+
+```pytest tests/```
+
+And if you want to include coverage reports:
+```pytest --cov=app/```
+