Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flippercloud/flipper-rails-demo
Basic Rails application running Flipper Cloud
https://github.com/flippercloud/flipper-rails-demo
feature feature-flags feature-toggle feature-toggles flipper flipper-cloud rails
Last synced: 3 months ago
JSON representation
Basic Rails application running Flipper Cloud
- Host: GitHub
- URL: https://github.com/flippercloud/flipper-rails-demo
- Owner: flippercloud
- Created: 2017-05-29T22:38:29.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T10:57:16.000Z (9 months ago)
- Last Synced: 2024-05-06T12:01:43.805Z (9 months ago)
- Topics: feature, feature-flags, feature-toggle, feature-toggles, flipper, flipper-cloud, rails
- Language: Ruby
- Homepage: https://playground.flippercloud.io
- Size: 587 KB
- Stars: 9
- Watchers: 6
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flipper Rails Playground
This is an example Rails application that serves as a playground and working demo to walk you through the basics of using Flipper. You can run the playground and interact with the feature toggles, or you can browse the source code to see the commands for toggling features.
## Automated Setup (Fast and Easy)
Once you've pulled down the repo, you should be able to run `bin/setup`, and the application will bootstrap everything for you.
```bash
$ bin/setup
```
This app already has the pre-requisites setup and ready to go.
## Manual Setup (See how it all works!)
1. Copy over the sample `.env` file
```bash
$ cp .env.example .env
```
1. Get your `FLIPPER_CLOUD_TOKEN` by going to your project's "Tokens" page in [Flipper Cloud](https://www.flippercloud.io/dashboard). (Create a test project if you'd_prefer.) You can use the existing token or create a new one and then copy the value into your `.env` file.
Once your `.env` is set up with the `FLIPPER_CLOUD_TOKEN` from your account, you can start up the application:
```bash
bundle install
bin/rails db:prepare
bin/rails server
```
Then, visit http://localhost:3000 in your browser.
* * *
# Adding Flipper to an Existing Rails App
Step by step instructions for using [Flipper](https://www.flippercloud.io) with Rails.
## Step 1
Add `flipper` to the `Gemfile`.
```console
$ bundle add flipper-active_record
```
* Run `bin/rails g flipper:setup` to generate migration for ActiveRecord adapter.
* Run `bin/rails db:migrate` to run migration for ActiveRecord adapter.
## Step 2
Create an account on [flippercloud.io](https://flippercloud.io) and get the token provided during signup.
## Step 3
### Configure cloud using ENV vars (preferred):
```
FLIPPER_CLOUD_TOKEN=
```
## Step 4
Test that everything works from console:
```bash
FLIPPER_CLOUD_TOKEN= bin/rails console
```
```ruby
irb(main):006:0> Flipper.enabled?(:foo)
=> false
irb(main):007:0> Flipper.enable(:foo)
=> true
irb(main):008:0> Flipper.enabled?(:foo)
=> true
```
Or test that it works using this demo application:
```bash
git clone https://github.com/fewerandfaster/flipper-rails-demo.git
cd flipper-rails-demo
FLIPPER_CLOUD_TOKEN= bin/rails server
```
Open http://localhost:3000 in your browser.
## Dotenv
This app also ships with dotenv so if you `cp .env.example .env` and tweak the token in `.env`, you won't need to export the `FLIPPER_CLOUD_TOKEN` env var for the Rails server or console.
## More?
Head on over to the [Flipper Cloud documentation](https://www.flippercloud.io/docs).
Or check out the [flipper README](https://github.com/jnunemaker/flipper) for links to more documentation and examples on the [types of enablements](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md) and how to [instrument](https://github.com/jnunemaker/flipper/blob/master/docs/Instrumentation.md) and [optimize](https://github.com/jnunemaker/flipper/blob/master/docs/Optimization.md) your usage of Flipper.