/birdnest

Reaktor internship challenge

Primary LanguageRubyMIT LicenseMIT

Birdnest

Continuous Integration Release

Birdnest is a simple web application that lists drones in a No-Drone Zone (NDZ). It was made for Reaktor's internship assignment.

Usage

Execute bin/birdnest to launch the web application. It is available on http://localhost:4000/.

Architecture

For this fairly simple assignment, a simple architecture was chosen. The application uses Sinatra to expose a web server, serving a single page. An embedded job scheduler fetches data every few seconds, and stores it in a Redis database with an expiry of 10 minutes.

Release

Update the changelog and bump the version using the bin/version tool. Run bin/version --help to see all parameters. Create a git tag for the version and push it to Github. A Docker image will automatically be built and pushed to Github Container registry.

bin/version version 1.0.0
git add lib/birdnest/version.rb
git commit -m "Bump version to v1.0.0"
git tag v1.0.0
git push origin master
git push origin v1.0.0

Contributing

  1. Fork the repository (https://github.com/floriandejonckheere/birdnest/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

See LICENSE.md.