AirCasting - Share your Air!

About

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.

Developing

Branching strategy

• master is stable code, which automatically deploys to aircasting.habitatmap.org. If you're setting up your own copy of Aircasting use this branch.

Prerequisite: Debian / Ubuntu

sudo apt-get install bzip2 curl subversion git-core -y
# install rvm https://rvm.io/rvm/install
sudo apt-get install build-essential openssl libreadline6 libreadline6-dev curl git-core zlib1g zlib1g-dev libssl-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt-dev autoconf libc6-dev ncurses-dev automake libtool bison subversion pkg-config imagemagick mysql-server libmysqlclient-dev redis-server libgsl0-dev nodejs -y

Prerequisite: Mac

# install rvm https://rvm.io/rvm/install
brew install gsl
brew install imagemagick
brew install redis
brew install [email protected]
# install node 12.x

App (any OS)

rvm install 2.6.3
rvm use 2.6.3
gem install bundler
git clone [email protected]:HabitatMap/AirCasting.git
cd aircasting
cp config/database.yml.example config/database.yml
# `socket:` in `config/database.yml` should be equal to the path from
# `mysqladmin variables -uroot | grep socket | grep "\.sock"`
cp config/configuration.yml.example config/configuration.yml
# fill proper configuration in config/configuration.yml
bundle install
yarn install
bin/rails db:create db:migrate
bundle exec foreman start
# visit http://localhost:3000/mobile_map

Obtaining a bitly access token

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.

Tests

run tests

RAILS_ENV=test bin/rails db:create db:migrate
bundle exec rspec
yarn test
yarn run elm-test app/javascript/elm/tests

lint/format files

format elm files:

yarn run elm-format --validate app/javascript/elm

format js and css files:

yarn prettier --write app/assets/stylesheets/path/to/your/file.scss
yarn prettier --write app/javascript/path/to/your/file.js

Best to add prettier to your editor to do this for you on save :) Same goes for elm-format.

API documentation

Read more here.

Importing a big db dump to a server, i.e. staging

For restoring a big db dump you can try to opitimize a process by changing the database configuration temporarily. See example post on Stack Overflow

mysql -u root -p

use MY_DATABASE_NAME;

set global net_buffer_length=1000000; --Set network buffer length to a large byte number

set global max_allowed_packet=1000000000; --Set maximum allowed packet size to a large byte number

SET foreign_key_checks = 0; --Disable foreign key checking to avoid delays,errors and unwanted behaviour

source file.sql --Import your sql dump file

SET foreign_key_checks = 1; --Remember to enable foreign key checks when procedure is complete!

Troubleshooting

Problems with mysql2 gem

If you run into the error libmysqlclient is missing while installing mysql2 then run brew install mysql-connector-c.

If you run into the error ld: library not found for -l-lpthread while installing mysql2 then check https://stackoverflow.com/questions/43661360/install-mysql2-gem-on-macos-sierra#answer-44790834

If you run into errors while installing mysql2 with exit code 2 try installing from this source.

If you run into problems with db:migrate related to passwords make sure that you change the root password to ''. To do that open /your/path/to/mysql -uroot -p provide the temporary password you were given during installation, then execute set password = password('');.

No sidekiq pid file / no public/packs/manifest.js file

No such file or directory @ rb_sysopen - /Users/username/Projects/AirCasting/tmp/pids/sidekiq.pid - create folder mkdir tmp/pids and rerun bundle exec foreman start. If you see an error that public/packs/manifest.js can't be found, this is a related error which should go away once the pid file is successfully created and the manifest file generated after that.

Contribute

If you'd like to contribute just use the usual github process - fork, make changes, issue a pull request.

Contact

You can contact the authors by email at [email protected].

Thanks

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.

License

The project is licensed under the GNU Affero GPLv3. For more information see COPYING and visit http://www.gnu.org/licenses/agpl.html.