Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rubyforgood/flaredown

Flaredown web app and API
https://github.com/rubyforgood/flaredown

chronic-illness ember emberjs hacktober-fest hacktoberfest hacktoberfest2021 health mhealth mongodb rails ruby

Last synced: 42 minutes ago
JSON representation

Flaredown web app and API

Host: GitHub
URL: https://github.com/rubyforgood/flaredown
Owner: rubyforgood
License: gpl-3.0
Created: 2016-02-16T21:55:05.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2024-12-14T10:28:13.000Z (11 days ago)
Last Synced: 2024-12-25T16:06:42.239Z (42 minutes ago)
Topics: chronic-illness, ember, emberjs, hacktober-fest, hacktoberfest, hacktoberfest2021, health, mhealth, mongodb, rails, ruby
Language: Ruby
Homepage: http://www.flaredown.com
Size: 17.5 MB
Stars: 40
Watchers: 10
Forks: 16
Open Issues: 105
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Flaredown
[![rspec](https://github.com/rubyforgood/Flaredown/actions/workflows/rspec.yml/badge.svg)](https://github.com/rubyforgood/Flaredown/actions/workflows/rspec.yml)
[![frontend](https://github.com/rubyforgood/Flaredown/actions/workflows/frontend.yml/badge.svg)](https://github.com/rubyforgood/Flaredown/actions/workflows/frontend.yml)
[![ERB lint](https://github.com/rubyforgood/Flaredown/actions/workflows/erb_lint.yml/badge.svg)](https://github.com/rubyforgood/Flaredown/actions/workflows/erb_lint.yml)
[![standardrb lint](https://github.com/rubyforgood/Flaredown/actions/workflows/ruby_lint.yml/badge.svg)](https://github.com/rubyforgood/Flaredown/actions/workflows/ruby_lint.yml)

Flaredown makes it easy for people to track symptoms over time, and learn how to control them. Our goal is to analyze the aggregate data from users of this tool to understand the probable effects of treatments and environmental stressors on chronic illness.

Help would be appreciated! Please join us in [slack #flaredown](https://rubyforgood.herokuapp.com/), raise a GitHub issue, or email .

## Environment

* PostgreSQL 12.8
* MongoDB 4.4.9
* Redis 6.2.3
* Ruby 3.2.3
* Node 12.22.6

## Installation

The application and all dependencies are dockerized and can be run using `docker compose`, so there's no dependencies to install other than Docker.
Alternatively, you can run the app using the `make` commands available: `make help`

If you want to run the application on your own machine see the next sections on dependency installations

### Running natively

#### Mac Prerequisites

_If you are running on an M1 mac, run the following command before you start the installation process:_
```bash
$env /usr/bin/arch -arm64 /bin/zsh ---login
```

_Remove all gems before you proceed_
```bash
gem uninstall -aIx
```

#### Backend

You can install the dependencies via [asdf-vm](https://asdf-vm.com/) declared in the `.tool-versions` file, or:
- [Ruby Version Manager](https://rvm.io/)
- [MongoDB installation on OSX](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/)

On macOS, you can install `libpq` by running `brew install libpq && brew link --force libpq && bundle config --local build.pg "--with-ldflags=-L$(brew --prefix libpq)/lib --with-pg-include=$(brew --prefix libpq)/include"`, which is required for `bundle install` to succeed.

```bash
cd backend
echo "gem: --no-ri --no-rdoc" > ~/.gemrc
bundle config set --local without 'production'
bundle config set --local jobs 5
bundle config set --local retry 10
bundle install
cp env-example .env # You may adjust it however you like
# RVM is going to autoload this on every 'cd' to the directory
bundle exec rake app:setup

gem install foreman
```

#### Frontend

```bash
cd frontend
npm install
```

#### React Native

```bash
cd native
npm install
```

## Development

### Prerequisites

- Populate the necessary environment parameters with `cp backend/env-example backend/.env && cp backend/env-example frontend/.env`
- Create a [Facebook dev app](https://developers.facebook.com/docs/development/create-an-app) and paste your own ID into `frontend/.env` file's `FACEBOOK_APP_ID` parameter.
- Note: This is not necessary in `backend/.env` but we have not yet cleaned up these two files into the necessary components.
- Seed your database using `make seed` or `bundle exec rails app:setup`

### Running

If you are running the application natively, run the following to start your server. If you're using docker, this should be up and running already.

```bash
rake run
```

Visit your app at [http://localhost:4300](http://localhost:4300) for the current ember application, or [http://localhost:19006](http://localhost:19006) for the React Native version.

## Running tests locally

1. Run `make build` or `docker compose build backend` to ensure the latest backend is built and being run
2. To run all tests run `make specs` or `script/backend rspec spec spec`, or you can run a specific test suite such as `script/backend rspec spec spec/services/weather_retriever_spec.rb `
3. Debugging tip: in Ruby code you can add a line that says `debugger` and rspec will automatically break on that line and give you an interactive Ruby shell

## CI

Several checks are configured to run on all commits using GitHub Actions, including lint, build and test steps. Definitions can be found in [./.github/workflows](./.github/workflows). Those checks which always run are required to be successful for pull requests to be merged.

## Deployment

Deployments target [Heroku](https://heroku.com). The traditional deployment is manually configured and is composed of two distinct applications (frontend and api) in two environments (staging and production), with automatic deployments to staging of commits to master:

* [flaredown-staging-api](https://dashboard.heroku.com/apps/flaredown-staging-api)
* [flaredown-staging-webapp](https://dashboard.heroku.com/apps/flaredown-staging-webapp) (https://app.flaredown.com)
* [flaredown-api](https://dashboard.heroku.com/apps/flaredown-api)
* [flaredown-webapp](https://dashboard.heroku.com/apps/flaredown-webapp) (https://staging.flaredown.com) (Temporarily https://flaredown-staging-webapp.herokuapp.com/login due to https://github.com/rubyforgood/Flaredown/issues/506)

Addons are used for Heroku Postgres, Heroku Redis, Heroku Scheduler + Papertrail. MongoDB is provided by mongodb.com.

## Style Guide

### 🎨 [Figma Assets](https://www.figma.com/proto/MBVn73pD6JbBkxd65KSZHr/Flaredown-Guide?page-id=0%3A1&node-id=1%3A3&viewport=241%2C48%2C0.45&scaling=contain&starting-point-node-id=1%3A3)

## Common Problems
* On first load, the app displays a blank beige screen instead of the login screen. Temporary fix is to add `console.log(process.env.FACEBOOK_APP_ID)` right inside of the module.exports at the top of the `frontend/config/environment.js` file. You can then refresh the page (no need to kill Docker) and this should fix it. You can now remove the log.

Flaredown is open source software made available under the GPLv3 License. For details see the LICENSE file.