Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/FranckKe/mersea

Web app to manage and visualise geolocalized waste report
https://github.com/FranckKe/mersea

cartography ecology environmental mapbox-gl-js rails vue

Last synced: 3 months ago
JSON representation

Web app to manage and visualise geolocalized waste report

Host: GitHub
URL: https://github.com/FranckKe/mersea
Owner: FranckKe
License: mit
Created: 2016-10-08T08:01:59.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-11-11T21:34:35.000Z (12 months ago)
Last Synced: 2024-05-29T16:58:41.534Z (5 months ago)
Topics: cartography, ecology, environmental, mapbox-gl-js, rails, vue
Language: Ruby
Homepage: https://oceanplastictracker.com
Size: 3.1 MB
Stars: 16
Watchers: 5
Forks: 4
Open Issues: 27
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

Open-Source-Ruby-and-Rails-Apps - mersea - Web app to manage and visualise geolocalized waste report 🔥 ✅ 🚀 (Happy Exploring 🤘)

README

![license](https://img.shields.io/dub/l/vibe-d.svg)

# Mersea

## Requirements

- Ruby MRI 2.7.x ([rbenv](https://github.com/rbenv/rbenv) recommended)
- Bundler
- Rails 6.x
- Postgres 9.5+ [configuration file](https://github.com/FranckKe/mersea/blob/master/config/database.yml)
- [ImageMagick](https://www.imagemagick.org/script/index.php)(for thumbnails)

### Setup

```sh
rbenv install
gem install bundler
```

## Development

Clone repository.

```sh
# 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](https://github.com/guard/listen/wiki/Increasing-the-amount-of-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:

```sh
bundle exec rails console
```

```rb
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

```sh
$ 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

```sh
# 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

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

## License

MIT. See the [LICENSE](https://github.com/FranckKe/mersea/blob/master/LICENSE) for more details.

## About

- [For more information about the project checkout the about and information section on oceanplastictracker.com](https://oceanplastictracker.com)

## 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_logos/bugsnagx128.png)](https://bugsnag.com) | Thanks to **Bugsnag** we can monitor and investigate errors on our application |
| [![Mapbox](thanks_logos/mapboxx128.png)](https://mapbox.com) | Thank you to **Mapbox** for their mapping services and tools |
| [![BrowserStack](thanks_logos/browserstackx128.png)](https://browserstack.com) | 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_logos/circlecix128.png)](https://circleci.com) | 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](Gemfile), [package.json](front/package.json))