Logo Lanfrica

Melliom/muslims-rwanda-backend

Domain:

digital infrastructure

Record type:

software
Creator:
Mel
Host:
The Rwanda Muslim app is a project that aims to make it easy for Muslims in Rwanda to access information about sallat, mosque location, prayer time, and in the future interact with sheikhs within the app and easily organize diverse preaching sessions # MUSLIM RWANDA APP The Rwanda Muslim app is a project that aims to make it easy for Muslims in Rwanda to access information about sallat, mosque location, prayer time, and in the future interact with sheikhs within the app and easily organize diverse preaching sessions. This is a monolith repo for the backend ( supporting the dashboard and the mobile app) and the front-end (for the dashboard), the stack used is `ruby`, `Ruby on Rails`, `react`, `redux`, `Postgres`, hosted on `Heroku` and files stored on `cloudinary` # Contribution ## Development setup and Installation Make sure you have ruby and node installed ``` Ruby 2.5.3 Rails 5.2.2 ``` Clone project ```sh git clone git@github.com:Melliom/muslims-rwanda-backend.git ``` Move to cloned repo ```sh cd muslims-rwanda-backend ``` Install dependencies ```sh bundle && yarn ``` Configuration: Refer to `config/application.template.yml` 1. database user and password 2. sendgrid: `send emails` you need to get your own sendgrid username and secret_key 3. cloudinary: `store images` api key secret and and api_key Setup db | run migration | seed super admin ```sh rails db:setup ``` This assumes that you have postgres installed Run app ```sh rails server ``` ## Usage The collection of request is shared on postman ## Authors > **Melliom** / **Hadad Dus** - @dusmel > **Melliom** / Twitter: @dusmel See also the list of contributors who participated in this project. ## License This project is licensed under the MIT License - see the LICENSE.md file for details ## Contributing 1. Fork it ( ) 2. Create your feature branch (`git checkout -b story/MRA-20-add-this`) convention 👉🏼 [here][convention-branch] 3. Commit your changes convention 👉🏼 [here][convention-commit] 4. Push to the branch (`git push origin `) 5. Create a new Pull Request ## ROADMAP [![TRELLO][trello-image]][trello-invite-link] [convention-branch]: github.com …