Skip to content

Latest commit

 

History

History
71 lines (40 loc) · 3.44 KB

README.md

File metadata and controls

71 lines (40 loc) · 3.44 KB

Orcamap ReactJS

Netlify Status

License: MIT

This project aims to organize and update the Orcamap code. The orcamap code implemented a 2019 prototype for mapping sounds heard through the Orcasound hydrophone network. It exchanged data with a Google spreadsheet and used Mapbox before they changed pricing model and close sourced some of their code.

Orcamap-react is a work in progress (2021-22+). This project was bootstrapped with Create React App. A test deployment via Netlify was accomplished at https://orcamap.netlify.app/ in mid-2021.

Setup

  1. Clone the repo.

Prerequistes

  • Install NodeJS on your development machine
  • Request access to Google Spreadsheets data source

Run

  1. Execute npm install .
  2. Execute npm start .

Environment

This project uses typescript version 4.1.2, please make sure your code editor is using this version (vscode uses 4.0.3 from its own node modules by default.) see this stack overflow

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.