OP
openscript/beefindr
BeeFinder connects beekeepers with wild or escaped hives.
Beefinder
BeeFinder (primary name; sometimes BeeFindr if BeeFinder is not available) connects beekeepers with wild or escaped hives.
Overview
- Continuous integration and delivery with TravisCI
https://travis-ci.org/openscript/beefindr - Backend with Firebase
https://console.firebase.google.com/project/beefindr - Hosting with Firebase
https://beefindr-dev.firebaseapp.com/ - Code quality with CodeClimate
https://codeclimate.com/github/openscript/beefindr - Test Coverage with CodeClimate
https://codeclimate.com/github/openscript/beefindr
Contribute
- Write commit messages in English and follow https://chris.beams.io/posts/git-commit/
Getting started
- Install git and configure your user and email
- Clone project
git clone git@github.com:openscript/beefindr.git - Set up development environment
- Install Visual Studio Code
- Install NodeJS and Yarn (preferably with asdf)
- NodeJS version
12.3.1for the Angular app - NodeJS version
8.15.0for the Firebase functions
- NodeJS version
- Install Angular CLI globally
yarn global add @angular/cli
- Change to the workspace
for example withcd - Install dependencies
yarn install - Run application and open browser
ng serve --open
Add a feature
- Clone or pull project
git clone git@github.com:openscript/beefindr.gitorgit pull - Create a new branch
git checkout -b features/[yourFeature] - Run tests
ng test --code-coverage - Push new branch to remote
git push --set-upstream origin features/[yourFeature] - Follow the
Add a pull requestinstructions
Add a pull request
- Finish development of your feature
- Make sure the tests are passing with
ng test --code-coverage
- Make sure the tests are passing with
- Merge any commit from the master into the feature branch
git merge master - Create a pull request
- Select a reviewer
- Make sure the checks are passing
- Make sure the branch is mergable
Tooling
The following sections contain additional information about the tools, which are used to develop this application.
asdf
This helps to manage differnt versions of NodeJS.
- Install asdf
- Install the nodejs plugin
withasdf plugin-add nodejs - Install the appropriate runtime (with .tool-versions)
by runningasdf installin the project root or functions folder
Glossary
The following terms should be used throughout.
| Term | Definition |
|---|---|
| beehive | Man made enclosure to keep bees. In this project it's also used for wild bee colonies. |
| beekeeper | A person who works with bees. |
