Do Five Things is a web application built with Ruby on Rails that helps users manage their daily tasks by limiting their focus to five tasks at a time. It is a daily to-do list so small it might actually be achievable.
- Ruby and Rails Versions
- Bundler Version
- Prerequisites
- Development Setup
- Usage
- Contributing
- Docs
- i18n
- Ruby version: 3.1.2
- Rails version: 7.1.3.4
- PostgreSQL version 15.7
- Bundler version: 2.5.4
- postgresql
- ruby
- rails
- Clone the repository:
git clone git@github.com:cherryontech/do-five-things.git- Navigate to directory:
cd do-five-things-
Install postgresql
-
Install dependencies:
bundle installyarn- Start the server:
web: env RUBY_DEBUG_OPEN=true bin/rails server
vite: bin/vite build --clear --mode=development- Alternatively
./bin/devwill startProcfile.devwhich will run all the commands together. Running the commands separately might be useful for debugging 😅 To use the application, open your web browser and navigate to http://localhost:3000.
Please follow the Conventional Commits style for commits.
For branch names, please use the conventional commits prefix, and be sure to include the name of the issue, if applicable (e.g. chore/19-reorder-settings-sections).
Please ensure units are present and passing for any work involves logic or goes beyond simple templating.
- inertia-rails_contrib gem
- Inertia.js Rails Adapter
- Ruby
- Ruby on Rails API
- Ruby On Rails guides
- vite-ruby
- Vue.js
This app uses vue-18n to provide translations for the app. The app isn't currently translated into languages other than English, but using i18n helps keep all of the UI text in one place. This makes it easier for non-coders to contribute strings, and will help us scale languages more gracefully in the future.
For compatibility, any additional languages must be added in both ./storybook/preview.js and /app/frontend/i18n.js.