https://github.com/extinctionrebellion/rebelsmanager
https://github.com/extinctionrebellion/rebelsmanager
extinction-rebellion foundation6 rubyonrails stimulusjs volunteer-opportunities world-changing
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/extinctionrebellion/rebelsmanager
- Owner: extinctionrebellion
- License: mit
- Created: 2019-08-12T11:22:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T16:12:26.000Z (7 months ago)
- Last Synced: 2024-10-29T13:17:04.247Z (7 months ago)
- Topics: extinction-rebellion, foundation6, rubyonrails, stimulusjs, volunteer-opportunities, world-changing
- Language: Ruby
- Homepage:
- Size: 28.1 MB
- Stars: 62
- Watchers: 7
- Forks: 20
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
You can start using the Rebels Manager for our own national branch or even at a local group/chapter level, but the app allows to manage multiple local groups/chapters. Please have a look at our wiki for more details, including a demo and screenshots.
The Rebels Manager wiki
=======================
We do our best to keep our wiki up-to-date with relevant information for national branches interested in using the Rebels Manager.
* [Wiki homepage](https://github.com/extinctionrebellion/RebelsManager/wiki)
* [Roadmap](https://github.com/extinctionrebellion/RebelsManager/wiki/Roadmap)
* [Demo and screenshots 📸](https://github.com/extinctionrebellion/RebelsManager/wiki/Demo-and-Screenshots)
* [Wanna contribute?](https://github.com/extinctionrebellion/RebelsManager/wiki/Wanna-contribute%3F)
Table of Contents
=================
* [Ruby version](#ruby-version)
* [Database setup (PostgreSQL)](#database-setup-postgresql)
* [ENV variables](#env-variables)
* [Tests](#tests)
* [Additional information](#additional-information)
* [Built With](#built-with)
* [Contributing](#contributing)
* [They contributed already 🙏](#they-contributed-already-)
* [License](#license)
* [Dedication](#dedication)
## Ruby version
2.6.3
## Setup
- clone repo
- run the following commands (the first one is optional, depending on your machine setup):
```
$ rbenv local 2.6.3
$ bundle install
$ yarn
$ cp .env.example .env
```
- set your POSTGRES_USER in the .env ( You can use specific [file per environment](https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use) and append `.local` to them if you want )
- run the following commands:
```
$ rails c
// use the generated key to set your LOCKBOX_MASTER_KEY env variable
irb> Lockbox.generate_key
$ rails db:prepare
```
## ENV variables
- ALLOWED_ORIGINS (eg. "extinctionrebellion.be,www.extinctionrebellion.be")
- APP_URL (eg. "https://rebels.extinctionrebellion.be")
- LOCKBOX_MASTER_KEY
- POSTGRES_USER
- POSTGRES_PASSWORD
- POSTGRES_HOST
- SENTRY_DSN (for reporting errors to Sentry)
- MAILTRAIN_API_TOKEN
- MAILTRAIN_API_ENDPOINT (eg. "https://lists.extinctionrebellion.be/api")
- MAILTRAIN_REBELS_LIST_ID
- XR_BRANCH_DEFAULT_LANGUAGE (eg. "en")
- XR_BRANCH_TIMEZONE (eg. "Europe/Tallinn", "PST" or "UTC")
## Tests
```
bundle exec rspec
```
## Additional information
### Built With
* Ruby on Rails
* PostgreSQL
* Redis (for Sidekiq)
Plus a bunch of awesome Ruby Gems, a complete list of which is at [/master/Gemfile](https://github.com/extinctionrebellion/RebelsManager/blob/master/Gemfile).
### Contributing
The Rebels Manager is 100% open source. We encourage and support an active, healthy community that accepts contributions from the public – including you!
Please have a look at our [Wanna contribute?](https://github.com/extinctionrebellion/RebelsManager/wiki/Wanna-contribute%3F) wiki page for more details about the profiles we are actively looking for.
#### They contributed already 🙏
All contributors can be found at https://github.com/extinctionrebellion/RebelsManager/graphs/contributors. Thanks a lot to all of them!
### License
### Dedication
The Rebels Manager is built with love and rage. We believe in open source software for good.