Skip to content

UBC-CIC/noise-tracker-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoiseTracker

The NoiseTracker prototype solution acts as a centralized information hub for hydrophone operators and members of the general public to learn more about the underwater soundscapes near them. The NoiseTracker interactive map allows users to view various noise metrics and metadata for each registered hydrophone. Through specialized interfaces, operators can view and download their hydrophones' settings, and administrators can modify the configuration settings for operators and their hydrophones. Also checkout the NoiseTracker Client Software that allows hydrophone operators to connect with the system. For more information, please visit the CIC Website.

Index Description
High Level Architecture High level overview illustrating component interactions
Deployment How to deploy the project
User Guide The working solution
Directories General project directory structure
Changelog Any changes post publish
Credits Meet the team behind the solution
License License details

High Level Architecture

The following architecture diagram illustrates the various AWS components utilized to deliver the solution. For an in-depth explanation of the frontend and backend stacks, refer to the Architecture Deep Dive.

Alt text

Deployment Guide

To deploy this solution, please follow the steps laid out in the Deployment Guide

User Guide

For instructions on how to navigate the web app interface, refer to the Web App User Guide.

Directories

├── backend
│   └── cdk
│       ├── bin
│       ├── lambda
│       └── lib
├── docs
└── frontend
    ├── public
    └── src
        ├── components
        ├── pages
  1. /backend/cdk: Contains the deployment code for the app's AWS infrastructure
    • /bin: Contains the instantiation of CDK stack
    • /lib: Contains the deployment code for all infrastructure stacks
    • /lambda: Contains lambda functions
  2. /docs: Contains documentation for the application
  3. /frontend: Contains the user interface of the application
    • /src/components: Contains components used in the application
    • /src/pages: Contains pages comprising the application's interface

Changelog

N/A

Credits

This application was architected and developed by Liam Driscoll and Arshia Moghimi, with project assistance from Franklin Ma. A special thanks to the UBC Cloud Innovation Centre Technical and Project Management teams for their guidance and support.

License

This project is distributed under the MIT License.

Licenses of libraries and tools used by the system are listed below:

MIT License

Used Material UI library to design user interface

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •