Bike registration that works: online, powerful, free.

Registering a 🚲 only takes a few minutes and gives 🚴‍♀️ a permanent record linked to their identity that proves ownership in the case of a theft.

We're an open source project. Take a gander through our code, report bugs, or download it and run it locally.

Dependencies

We recommend mise for managing versions of Ruby and Node. Check the .tool-versions file to see the versions of required versions of:

• Ruby

• Node

Bike Index also requires some additional libraries. We recommend installing them via your system package manager / homebrew

• PostgreSQL

• Redis

• libvips and imagemagick for image manipulation

  • Eventually, imagemagick will only be required for testing (via chunky_png), but we're not there yet

Running Bike Index locally

Follow the Getting Started guide for a complete set up. Or if you're familiar with developing Ruby on Rails applications start with these steps and a local Postgresql installation:

• bin/setup sets up the application and seeds test organizations, bikes and users:

  • Four test user accounts: [email protected], [email protected] (developer), [email protected], [email protected] (all have password pleaseplease12)
  • Gives [email protected] 50 bikes
  • Give test organization Brakebills all organization features and some test parking notifications

• bin/dev start the server. It starts redis in the background and runs foreman with the dev procfile. If you need/prefer something else, do that. If your "something else" isn't running at localhost:3042, change the appropriate values in Procfile.dev and .env

• Go to localhost:3042

Toggle in development	command	default
Caching	bundle exec rails dev:cache	disabled
logging with lograge	bin/rake dev:lograge	enabled

Sent emails are captured by letter_opener_web and viewable at localhost:3042/letter_opener.

Localization

See the localization docs for details (we use translation.io for localization).

Testing

We use RSpec and Guard for testing.

• 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 fuzzystrmatch extension, 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_development and psql bikeindex_test) and add the extension.

  CREATE EXTENSION fuzzystrmatch;
  

We use turbo_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/turbo_tests

• Run bin/rake parallel:prepare to synchronize the test db schema after migrations (rather than db:test:prepare).

• Run specific files or test directories with bin/turbo_tests <FILES_OR_FOLDERS>

• Run Guard with parallelism bin/guard -G Guardfile_parallel

• Parallel test databases are not migrated by default. After running migrations, sync them with bin/rake parallel:prepare (see above), or opt into automatic parallel migrations on db:migrate with PARALLEL_MIGRATIONS=true bin/rake db:migrate.

Code Hygiene

We use the following tools to automate code formatting and linting:

• EditorConfig
• StandardRB
• ESlint

Run bin/lint to automatically lint the files and/or add auto formatters to your text editor (e.g. prettier-standard)

EditorConfig

EditorConfig ensures whitespace consistency. See the Download a Plugin section of the EditorConfig docs to find a plugin appropriate to your editor.

StandardRB

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.

StandardJS

standard is configured to run on project JavaScript.

Install it with npm install

Run it with npm run lint.

Bug tracker

Have a bug or a feature request? Open an issue.

Community

Keep track of development and community news.

• Follow @bikeindex on Twitter.
• Read the Bike Index Blog.

Contributing

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