BeeFinder (primary name; sometimes BeeFindr if BeeFinder is not available) connects beekeepers with wild or escaped hives.
- 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
- Write commit messages in English and follow https://chris.beams.io/posts/git-commit/
- 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.1
for the Angular app - NodeJS version
8.15.0
for 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
- Clone or pull project
git clone git@github.com:openscript/beefindr.git
orgit 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 request
instructions
- 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
The following sections contain additional information about the tools, which are used to develop this application.
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 install
in the project root or functions folder
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. |