Bike registration that works: online, powerful, free.
We're an open source project. Take a gander through our code, report bugs, or download it and run it locally.
PostgreSQL >= 9.6
Requires 1gb of ram (or at least more than 512mb)
Running Bike Index locally
This explanation assumes you're familiar with developing Ruby on Rails applications.
bin/setupsets up the application and seeds:
./startstart the server.
Go to localhost:3001
|Toggle in development||command||default|
|logging with lograge||
See the internationalization docs for details.
Run the test suite continuously in the background with
bin/guard(watches for file changes/saves and runs those specs)
You may have to manually add the
fuzzystrmatchextension, which we use for near serial searches, to your databases. The migration should take care of this but sometimes doesn't. Open the databases in postgres (
psql bikeindex_test) and add the extension.
CREATE EXTENSION fuzzystrmatch;
parallel_tests to run the test suite in parallel. By default, this will spawn one process per CPU in your computer.
Run all the tests in parallel with
bin/rake parallel:prepareto synchronize the test db schema after migrations (rather than
Run specific files or test directories with
Run Guard with parallelism
bin/guard -G Guardfile_parallel
We use the following tools to automate code formatting and linting:
bin/lint to automatically lint the files and/or add auto formatters to your text editor (e.g. prettier-standard)
EditorConfig ensures whitespace consistency. See the Download a Plugin section of the EditorConfig docs to find a plugin appropriate to your editor.
StandardRB is an opinionated Ruby style guide, linter, and formatter - it is "a spiritual port of StandardJS".
See the how do I run standard in my editor section of the StandardRB docs to find an appropriate plugin for on-the-fly linting.
Have a bug or a feature request? Open an issue.
Keep track of development and community news.
Open a Pull request!
Don't wait until you have a finished feature before before opening the PR, unfinished pull requests are welcome! The earlier you open the pull request, the earlier it's possible to discuss the direction of the changes.
Once the PR is ready for review, request review from the relevant person.
If your pull request contains Ruby patches or features, you must include relevant Rspec tests.
... and go hard