Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/HabitatMap/AirCasting

AirCasting API and web application
https://github.com/HabitatMap/AirCasting

Last synced: about 1 month ago
JSON representation

AirCasting API and web application

Host: GitHub
URL: https://github.com/HabitatMap/AirCasting
Owner: HabitatMap
License: agpl-3.0
Created: 2012-01-17T13:18:37.000Z (almost 13 years ago)
Default Branch: master
Last Pushed: 2024-10-28T15:48:39.000Z (2 months ago)
Last Synced: 2024-10-29T16:19:26.449Z (2 months ago)
Language: TypeScript
Homepage: http://aircasting.org
Size: 13.3 MB
Stars: 61
Watchers: 10
Forks: 32
Open Issues: 29
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

open-sustainable-technology - AirCasting - The project aims to build a platform for gathering, visualization and sharing of environmental data. (Natural Resources / Air Quality)

README

[![Build Status](https://travis-ci.com/HabitatMap/AirCasting.svg?branch=master)](https://travis-ci.org/HabitatMap/AirCasting)
[![Code Climate](https://codeclimate.com/github/HabitatMap/AirCasting/badges/gpa.svg)](https://codeclimate.com/github/HabitatMap/AirCasting)

# 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](http://aircasting.habitatmap.org).

## Deploy

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`

## Setup

```bash
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
```

### configuration.yml

Set up access tokens to be able to access Google Maps and other services.

Please contact development team for develompent credentials.

### 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.

## Development

Make sure that redis is running

```bash
redis-server
```

Start all 3 processes in separate terminal windows for full control.

```bash
unset PORT && env RUBY_DEBUG_OPEN=true bin/rails server
```

```bash
yarn dev
```

```bash
bin/sidekiq
```

If sidekiq can't find the correct bundler version run:

```bash
eval "$(rbenv init -)"
```

## Tests

```bash
RAILS_ENV=test bin/rails db:create db:migrate
bin/rspec
yarn test
yarn elm-test app/javascript/elm/tests
```

## Formatting

Check:

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

yarn prettier --check "**/*.{scss,js,rb}"
```

Update:

```bash
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.

## Feature flags

We use Flipper as a feature flag solution. Feature flags are managed via Flipper Cloud Dashboard.

Setup:

1. Create an account on flippercloud.io and ask someone from the team to give you access to our organization.
2. 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

## API documentation