-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Move the development section from README to CONTRIBUTING
- Loading branch information
Showing
2 changed files
with
50 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Development | ||
|
||
Mbaza is based on [Electron React Boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate), | ||
which uses | ||
[Electron](https://electron.atom.io/), | ||
[React](https://facebook.github.io/react/), | ||
[React Router](https://github.com/reactjs/react-router), | ||
[Webpack](https://webpack.js.org/), | ||
[React Fast Refresh](https://www.npmjs.com/package/react-refresh). | ||
|
||
Useful files (sample data, biomonitoring stations, icons) | ||
can be found on our Drive (Appsilon-internal; see bookmarks on the Slack channel) | ||
|
||
To be able to run inference, | ||
download the ONNX models and place them in the `assets/models` directory: | ||
* [Central African forests (Gabon)](https://drive.google.com/uc?export=download&id=1HHmUdq5kUib2e05YgtBQGyS-146-Q5S5) | ||
* [East African savannas (Serengeti)](https://drive.google.com/uc?export=download&id=1UeJ4nIv_uORhmYqRGAKRjmcG39gTcBKn) | ||
* [East African savannas (Ol Pejeta Conservancy)](https://drive.google.com/uc?export=download&id=1YpRLde9t2OL-60a0M3vNeoem5tK6JjXJ) | ||
|
||
The model file names should match the entries in `src/common/models.ts`. | ||
|
||
## Commands | ||
|
||
You can run the following commands from the project root. | ||
You'll need [Node.js](https://nodejs.org/en/) 16 or later on your system. | ||
|
||
* `npm install`: Install dependencies. | ||
* `npm start`: Start the app in development mode. | ||
* `npm run lint`: Lint sources. | ||
* `npm run lint -- --fix`: Lint sources and fix errors automatically. | ||
* `npm run package`: Package the app for the local platform. | ||
* `npx cross-env DEBUG_PROD=true npm run package`: Package the app with developer tools enabled. | ||
|
||
## Definition of Done | ||
|
||
1. All changes are introduced in pull requests, | ||
which must be peer-reviewed before being merged. | ||
2. Tasks, design decisions, etc. are described in GitHub issues and pull requests. | ||
3. README and code comments are updated. | ||
4. Changes are tested (manually or with automated tests): | ||
1. No existing functionality is broken. | ||
2. Installed app works well on all systems. | ||
3. The app can handle our sample data. | ||
5. The code adheres to the [Airbnb style guide](https://github.com/airbnb/javascript). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters