Skip to content

Latest commit

 

History

History
181 lines (113 loc) · 5.8 KB

README.md

File metadata and controls

181 lines (113 loc) · 5.8 KB
Raw

Invasive Species BC

img Dev Build Successful Quality Gate Status codecov

Introduction

Invasive species are non-native plants and animals whose introduction and spread in British Columbia cause significant economic, social or environmental damage. This application tracks the observation, treatment, and monitoring of invasive species in the Province of British Columbia.

This project is part of the Species and Ecosystems Information System Modernization (SEISM) program.

Table of Contents

  1. Project Status
  2. Audience
  3. Features
  4. Getting Help or Reporting an Issue
  5. How to Contribute
  6. Architecture
  7. Project Structure
  8. Documentation
  9. Requirements
  10. Setup Instructions
  11. Running the Application
  12. License

Project Status

This application is in active development and has not yet been released.

Audience

Anyone with a valid IDIR or BCeID login may access the application to view data that is being tracked.

In addition, the application is intended for use by:

  • Surveyors who observe and record the absence, presence, and spread of invasive species
  • Subject matter experts who perform a variety of duties, including to record and analyze data and create action plans
  • Contractors who implement recommended treatments for observed invasive species
  • Administrators who manage the application and its users

Features

This application is anticipated to include the following main features:

  1. Support for IDIR and BCeID access
  2. User roles and permissions management
  3. Interactive maps displaying multiple data layers
  4. Observations of invasive species absence/presence
  5. Recommendations, planning, and application records of treatments
  6. Monitoring of treatment outcomes
  7. Query and export of data
  8. Auditing and reports
  9. Bulk data entry and mobile device data entry

Getting Help or Reporting an Issue

To report bugs/issues/features requests, please file an issue.

How to Contribute

If you would like to contribute, please see our contributing guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Architecture

This application uses PostgreSQL (with PostGIS), Ionic/React (for Web, IOS and Android). Our environments run on an OpenShift container platform cluster.

Project Structure

.config/                   - Common application configuration
.github/                   - Github actions
.docker/                   - Common Dockerfiles 
.vscode/                   - IDE config for Visual Studio Code
api/                       - API codebase
app/                       - Ionic APP Codebase
database/                  - Database Codebase
env_config/                - ENV config files
testing/                   - Test scripts, in particular Postman configs
CODE-OF-CONDUCT.md         - Code of Conduct
CONTRIBUTING.md            - Contributing Guidelines
LICENSE                    - License

Documentation

Requirements

We are using Visual Code for our IDE due to the excellent integration of our tolls and utilities.

Development

Ionic/React

npm install -g @ionic/cli native-run cordova-res

The ideal multi-platform supporting machine is the Mac, But Windows and Linus work very well for Web and Android as well.

Android Development

Install AndroidStudio and the Android SDK.

IOS Development

On MacOS: Install xCode.

Setup Instructions

Clone the repository to your own machine and follow instructions below.

Run the app locally (web)

In the app directory:

npm install

ionic serve

Run the app on mobile

Android

On MacOS, Windows or Linux, in the app directory:

  1. npm install
  2. ionic build
  3. ionic cap add android (Only the first time, does not need to be repeated after)
  4. ionic cap copy
  5. ionic cap sync
  6. npx cap open Android

Android Studio will open and, after a short delay, will allow you to run the application in the simulator.

IOS

On MacOS, in the app directory:

  1. npm install
  2. ionic build
  3. ionic cap add android (Only the first time, does not need to be repeated after)
  4. ionic cap copy
  5. ionic cap sync
  6. npx cap open ios

xCode will open and, after a short delay, will allow you to run the application in the simulator.

Acknowledgements

SonarCloud

License

Copyright 2019 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.