junjizhi / converge

Converge: A base app for building tourists marketplace / bookings sites

README

This repo is a basis for building tourist marketplace / bookings app. Built on Rails 5, the app comes with a beautiful and responsive landing page of the Bootstrap Theme theme.

The app also comes with basic functionalities like bookings management, user sign-up and log-in, and basic permission management with cancancan.

Note: The app needs further CUSTOMIZATION to be actually usable.

Screenshots

Dependencies

Below is the environment I tested on:

$ ruby -v
ruby 2.5.0p0 (2017-12-25 revision 61468) [x86_64-darwin17]

$ rails --version
Rails 5.2.3

By default, the app depends on postgres v9.6.

Database creation & initialization

bundle exec rake db:create
bundle exec rake db:migrate

Note: The user model is created with the Devise gem.

Running the app locally

export DATABASE_URL=postgres://<DB_USER>:<DB_PASS>@localhost:5432/converge-dev
export RAILS_ENV=development
bundle exec rails s

Visit the page: http://localhost:3000/

Gems already installed

• Bootstrap
• Devise
• jquery
• material-sass
• bootstrap_form
• cancancan

Customize the app

• Rename the app (search and replace converge with your app's name)
• Add other data models / controllers / views, such as tour guides, travel agencies
• Usual Rails app development stuffs...

Contributing

To contribute, follow the steps:

• Fork this repo and clone to your local machine
• Create your feature branch (git checkout -b my-awesome-feature)
• Commit your changes (git commit -am 'Implement blah')
• Push to your branch (git push origin my-awesome-feature)
• Create a new pull pequest (PR) with a brief description of what and why.
• Get notified when your PR is merged!

Issues and pull requests are always welcome!