Coder Social home page Coder Social logo

zonque / alride Goto Github PK

View Code? Open in Web Editor NEW
14.0 4.0 6.0 284 KB

Very simple ride sharing tool, implemented with Ruby on Rails

License: GNU Affero General Public License v3.0

Ruby 77.27% JavaScript 1.06% HTML 10.47% SCSS 2.04% Haml 7.96% Dockerfile 0.62% Shell 0.58%

alride's Introduction

Build Status

AlRide - simple ride sharing platform

AlRide is a ride sharing platform that is as simple as is gets.

Anyone may enter ride offers and ride requests, and other people are able to contact the submitter through a contact form. The email address is not shown to anyone on the website, but only stored internally. The main view will only show database entries that are in the future (minus some slack).

Each entry has a random secret assigned that is attached to a removal link which is added to every mail that is sent to an entry submitter. This way, no user management, authentication logic, role management or anything is needed.

Built with Rails, Bootstrap and HAML.

Installing

Self-hosting

AlRide is a standard Rails 7 application. You can pretty much follow any of the available install guides, or follow the one below.

Basically, to get started you need git, ruby (>= 3.0) and the bundler gem, then follow these steps.

  1. Clone the repository
    git clone git://github.com/zonque/AlRide.git
  1. cd into the directory
    cd AlRide
  1. Install all necessary gems:
    bundle install

If you want to use sqlite in your production environment, make sure to add gem 'sqlite' to the production group of Gemfile before running the bundle command.

  1. Create and modify settings:
    cp config/settings/template.yml config/settings.local.yml

In particular, make sure to set the secret token for your application in the settings. rake secret will generate one for you.

  1. Create and setup the database
    rake db:setup
  1. Precompile assets (only needed for production)
    rake assets:precompile
  1. Start the server

To start AlRide in the development environment simply run

    bundle exec rails server

To start AlRide in the production environment make sure you did not skip step 6 and run:

    rails server -e production

(Note that for a "real" production environment you should really use something like unicorn or passenger.)

Navigate to http://localhost:3000/ to use AlRide.

Configuration through environment variables

Environment variables can be used to override settings passed in YAML files such as config/settings.local.yml. Keys must be prefixed with ALRIDE and the nesting separator is __. So for example, in order to set the platform name, you would set the environment variable ALRIDE__platform_name prior to starting the application server.

Heroku

Alternative to host AlRide on your own hardware, you can host AlRide on Heroku. To make this even quicker, click on the button below:

Deploy To Heroku

That will setup everything on heroku, all you'll need to provide is the application name and URL.

Customize

The page header on the default welcome screen can be customized by putting Markdown formatted content into a file called config/page_header.<I18n>.md, where <I18n> is one of the supported locale variables (en, de, ...).

If such a files doesn't exist, the configured platform name is shown instead.

Contribute

To contribute, please clone the project and send pull requests through GitHub.

License

All code in this repository is released under the GNU Affero General Public License unless explicitly stated differently. Please refer to the LICENSE file for more detailed information.

TODO

  • Add more localizations

  • Fix bugs listed in the issue tracker of the GitHub project

alride's People

Contributors

dependabot[bot] avatar svenfoo avatar zonque avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

alride's Issues

Add Travis CI

Once tests are in place (#2), setting up Travis for CI should be simple.

Add tests

There are no tests at the moment. We should add some.

Upgrade to Bootstrap 3

There's no urgent need for that, but we should probably try to keep all components as up-to-date as possible.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.