This is the main repository for the Aqualink Coral Monitoring Application.
Aqualink is a philanthropically funded system to help people manage their local marine ecosystems in the face of increasing Ocean temperatures. The system consists of satellite-connected underwater temperature sensors and photographic surveys to allow for remote collaboration with scientists across the world. If you are concerned about the effect of climate change on your local reef and want to do something about it then please apply to get a smart buoy for free.
The app is a monorepo managed by Lerna using
Yarn Workspaces. Individual packages are found in the
./packages directory. The app has two primary components:
Commands can either be run for a specific package by changing to the package subdirectory and running them directly , or for the entire project by running them here in this directory.
To get started, run
yarn install from this directory. This will install all dependencies for all the packages. You
will also need to do some package-specific configuration such as setting up a
.env file for environment variables
- see the individual package READMEs for details on this process.
# Build all of the packages yarn build # Run tests for all of the packages yarn test # Start up all of the packages locally yarn start # Lint a specific file yarn lint ./packages/api/src/path/to/file.ts # Lint all the files in the app yarn lint:all
We are using Google App Engine to deploy applications. The default project we are using is
- Install the Gloud CLI using the instructions available here
- Make sure you are logged in by running
gcloud auth login
- The run the following commands:
# Set the project to ocean-systems gcloud config set project ocean-systems # Deploy to Google Cloud yarn deploy # Wait and verify that the app is running gcloud app browse
Aqualink is an MIT-licensed open source project. Contributions from developers and scientists are welcome!
Aqualink is MIT licensed.