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

1. Install git and configure your user and email
2. Clone project
   git clone git@github.com:openscript/beefindr.git
3. Set up development environment
   • Install Visual Studio Code
   • Install NodeJS and Yarn (preferably with asdf)
     • NodeJS version 12.3.1 for the Angular app
     • NodeJS version 8.15.0 for the Firebase functions
   • Install Angular CLI globally
     yarn global add @angular/cli
4. Change to the workspace
   for example with cd
5. Install dependencies
   yarn install
6. Run application and open browser
   ng serve --open

Add a feature

1. Clone or pull project
   git clone git@github.com:openscript/beefindr.git or git pull
2. Create a new branch
   git checkout -b features/[yourFeature]
3. Run tests
   ng test --code-coverage
4. Push new branch to remote
   git push --set-upstream origin features/[yourFeature]
5. Follow the Add a pull request instructions

Add a pull request

1. Finish development of your feature
   • Make sure the tests are passing with ng test --code-coverage
2. Merge any commit from the master into the feature branch
   git merge master
3. 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.

1. Install asdf
2. Install the nodejs plugin
   with asdf plugin-add nodejs
3. Install the appropriate runtime (with .tool-versions)
   by running asdf install in 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.

Ressources

• [Tutorial] AngularFire2: Installation and Setup
• [Tutorial] Angular 7: Firebase Authentication
• [Media] Bee for the logo
• [Media] Map for the logo
• [Tutorial] Material UI: Getting started