This is the AirCasting project - the project aims to build a platform for gathering, visualization and sharing of environmental data. To learn more about the platform visit aircasting.habitatmap.org.
To deploy to experimental server use the command:
SERVER=EXPERIMENTAL_SERVER_IP BRANCH=your-branch bundle exec cap server deploy
To deploy to staging server use the command:
SERVER=STAGING_SERVER_IP BRANCH=staging bundle exec cap server deploy
To deploy to production server use the command:
SERVER=aircasting.habitatmap.org BRANCH=master bundle exec cap server deploy
ruby -v
# this command should print the same version as in .ruby-version
# if it's not install and set the correct ruby version
# using https://github.com/rbenv/rbenv
# please make sure you have installed and turned on a correct version of node
# available in the `.nvmrc` file
# run:
bin/setup
Set up access tokens to be able to access Google Maps and other services.
Please contact development team for develompent credentials.
Go to https://bitly.com/ create an account and log in. To generate the token go to Settings -> Advanced settings -> For Developers -> OAuth -> Generic Access Token.
Make sure that redis is running
redis-server
Start all 3 processes in separate terminal windows for full control.
unset PORT && env RUBY_DEBUG_OPEN=true bin/rails server
yarn dev
bin/sidekiq
If sidekiq can't find the correct bundler version run:
eval "$(rbenv init -)"
RAILS_ENV=test bin/rails db:create db:migrate
bin/rspec
yarn test
yarn elm-test app/javascript/elm/tests
Check:
yarn run elm-format --validate app/javascript/elm
yarn prettier --check "**/*.{scss,js,rb}"
Update:
yarn run elm-format app/javascript/elm
yarn prettier --write app/assets/stylesheets/path/to/your/file.scss
yarn prettier --write app/javascript/path/to/your/file.js
yarn prettier --write app/path/to/your/file.rb
Best to add elm-format and prettier to your editor to do this for you on save.
We use Flipper as a feature flag solution. Feature flags are managed via Flipper Cloud Dashboard.
Setup:
- Create an account on flippercloud.io and ask someone from the team to give you access to our organization.
- Copy token from an environment named "Your Environment" to
.env
file.
Example of usage:
if Flipper.enabled?(:calendar)
# show calendar
else
# calendar unavailable
end
Documentation: https://www.flippercloud.io/docs/introduction
Read more here.
If you'd like to contribute just use the usual github process - fork, make changes, issue a pull request.
You can contact the authors by email at info@habitatmap.org.
AirCasting uses The YourKit Java Profiler for Performance Tuning
YourKit is kindly supporting open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products: YourKit Java Profiler and YourKit .NET Profiler.
The project is licensed under the GNU Affero GPLv3. For more information see COPYING and visit http://www.gnu.org/licenses/agpl.html.