158 lines
7.0 KiB
Markdown
158 lines
7.0 KiB
Markdown
# Flaredown
|
|
[](https://github.com/rubyforgood/Flaredown/actions/workflows/rspec.yml)
|
|
[](https://github.com/rubyforgood/Flaredown/actions/workflows/frontend.yml)
|
|
[](https://github.com/rubyforgood/Flaredown/actions/workflows/erb_lint.yml)
|
|
[](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://join.slack.com/t/rubyforgood/shared_invite/zt-3ej5oyume-_rhWjVi3bYi83RyS3nuxTg), raise a GitHub issue, or email <contact@flaredown>.
|
|
|
|
## Environment
|
|
|
|
* PostgreSQL 12.8
|
|
* MongoDB 4.4.9
|
|
* Redis 6.2.3
|
|
* Ruby 3.2.3
|
|
* Node 12.22.6
|
|
|
|
## Installation
|
|
|
|
You can run the application and its dependencies using `docker compose`, or run the app natively using the setup instructions below.
|
|
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 with Docker
|
|
|
|
Populate the necessary environment parameters:
|
|
|
|
```bash
|
|
cp backend/env-example backend/.env
|
|
cp frontend/env-example frontend/.env
|
|
```
|
|
|
|
In `frontend/.env`, `PORT` is the backend API port used by the Ember app and `FRONTEND_PORT` is the local frontend port.
|
|
|
|
Set `FACEBOOK_APP_ID` in `frontend/.env` if you want to use Facebook login locally.
|
|
|
|
Set up the database:
|
|
|
|
```bash
|
|
docker compose --profile tools run --rm app-setup
|
|
```
|
|
|
|
This command is interactive and resets the local Docker development and test databases. Type `yes` when prompted to continue.
|
|
|
|
Start the application:
|
|
|
|
```bash
|
|
docker compose --profile dev up
|
|
```
|
|
|
|
Visit your app at [http://localhost:4300](http://localhost:4300).
|
|
|
|
Frontend dependency changes are handled automatically by Docker. For a full reset of all local Docker data, including databases and dependency volumes, run `docker compose down -v`, then run the database setup command again afterward.
|
|
|
|
### 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 frontend/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.
|
|
- Reset, migrate, load fixtures, and 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.
|
|
|
|
## License
|
|
Copyright 2015-2024 Logan Merriam and contributors.
|
|
|
|
Flaredown is open source software made available under the GPLv3 License. For details see the LICENSE file.
|