Skip to content

Latest commit

 

History

History
130 lines (89 loc) · 4.44 KB

README.md

File metadata and controls

130 lines (89 loc) · 4.44 KB
Raw

license

Mersea

Requirements

Setup

rbenv install
gem install bundler

Development

Clone repository.

# Install and configure db
$ bundle install
$ bundle exec rails db:create
$ bundle exec rails db:migrate

# Add static pages
$ bundle exec rails db:seed

# Launch app
$ bundle exec rails s

Increase inotify watchers.

ReCaptcha is disabled in development. Configure key if needed using RECAPTCHA_SECRET_KEY and RECAPTCHA_SITE_KEY.

Create an admin account

Within a Rails console:

bundle exec rails console
Admin.create(name: 'myname', email: '[email protected]', password: 'mypassword')

Admin section is reachable at /admin.

Frontend

To setup frontend, see readme in ./frontend.

Production with Docker

Configure your reCaptcha keys as environment variables

  • Start server via Docker Compose
$ cd /path/to/mersea
$ docker-compose up -d

Feel free to modifies the provided docker-compose.yml to your needs.

http://localhost:3000

  • Start a Rails console
# mersea_mersea_1 is the container name defined by docker-compose
$ docker exec -it mersea_mersea_1 bundle exec rails c

To set any environment variable in the container, use one or more -e flags:

  • JWT_SECRET → the JWT secret
  • MERSEA_NAMESPACE → namespace the url
  • RAILS_SERVE_STATIC_FILES → the webapp serves all the assets instead of NGINX
  • MERSEA_DATABASE_POOL → database connection pool size
  • MERSEA_DATABASE_HOST → database host (IP address or URL)
  • MERSEA_DATABASE_PORT → database port (by default 5432)
  • MERSEA_DATABASE_USERNAME → database credential
  • MERSEA_DATABASE_PASSWORD → database credential
  • RECAPTCHA_SITE_KEY → Google reCaptcha key
  • RECAPTCHA_SECRET_KEY → Google reCaptcha secret
  • BUGSNAG_API_KEY → Bugsnag key (leave empty to disable error reporting)

Datagouv export

# Configure .env file with datagouv credentials
bundle exec rake datagouv

License

MIT. See the LICENSE for more details.

About

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Ensure specs and Rubocop pass
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

Special thanks

We would like to thanks the following companies for their open source plans and support
Bugsnag Thanks to Bugsnag we can monitor and investigate errors on our application
Mapbox Thank you to Mapbox for their mapping services and tools
BrowserStack Thank you to BrowserStack for their testing platform. It allows us to seamlessly test our web application on different devices and browser
Circle-ci Thanks to Circleci we can build efficient ci/cd pipelines

Thanks to all the open source tools we are using to make our application (gemfile, package.json)