CodeForBangladesh / prochaar

Rails API for creating a alert system for missing persons.

README

Features

• User Registration
• Complete user profile
• Collect User location using google maps API
• Report missing person
• Location wise push search notifications after a specific time

Requirements

• Ruby: 2.4.1
• Rails: 5.1.4
• MySQL

Installation

• Install ruby using RVM
• Install MySQL
• Clone the repository.
• Goto cloned repository using - cd prochaar/ (or whatever your local project folder name)
• Install required gems(libraries) - bundle install
• Create a database.yml and secrets.yml file in config folder. There is a database.sample.yml and secrets.sample.yml file in the same directory. Copy and paste the contents of those files in your newly created YAML file. Then change accordingly. (e.g. change database username/password/db_name)
• In your command line run - rake db:create (It'll create a new database in mysql)
• In your command line run - rake db:migrate (It'll add tables to your newly created database)
• In your command line run - rake db:seed (It'll create a admin user in the USERS table)

How to run with Docker Compose

• Prerequisites: Docker and Docker Compose
• Run following command:
  • make docker-build
  • make docker-up
• Visit http://localhost:3000/ in your browser.

Usage

• In the project's epics folder, there is a prochaar.postman_collection.json file.
• Import the file as a collection into POSTMAN
• You're now able to see the request patterns!
• Also, in the epics folder, ER_Diagram.uml file shows the ER Diagram of current Database Structure.

Contribute

Fork the repository then create pull request.

Happy Contributing!