https://github.com/truggeri/chore-schedule

Simple chore scheduling app
https://github.com/truggeri/chore-schedule

deployed dockerfile heroku minitest postgresql ruby ruby-on-rails

Last synced: 4 days ago
JSON representation

Simple chore scheduling app

• Host: GitHub
• URL: https://github.com/truggeri/chore-schedule
• Owner: truggeri
• License: mit
• Created: 2019-04-14T15:49:51.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-08T20:11:38.000Z (over 1 year ago)
• Last Synced: 2023-03-09T03:52:04.311Z (over 1 year ago)
• Topics: deployed, dockerfile, heroku, minitest, postgresql, ruby, ruby-on-rails
• Language: Ruby
• Homepage: https://choreplan.truggeri.com
• Size: 1.71 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Chore Schedule

[![Test](https://github.com/truggeri/chore-schedule/actions/workflows/ruby.yml/badge.svg)](https://github.com/truggeri/chore-schedule/actions/workflows/ruby.yml)

![Coverage badge](https://img.shields.io/badge/coverage-92%25-brightgreen.svg)

![RoR Badge](https://img.shields.io/badge/-Ruby_On_Rails-b32424?style=flat&labelColor=cc0000&logo=ruby-on-rails&logoColor=white)

![Postgres Badge](https://img.shields.io/badge/-PostgreSQL-426078?style=flat&labelColor=336791&logo=postgresql&logoColor=white)

![Heroku Badge](https://img.shields.io/badge/-Heroku-45197f?style=flat&labelColor=430098&logo=heroku&logoColor=white)

![Docker Badge](https://img.shields.io/badge/-Docker-4b99d4?style=flat&labelColor=2496ED&logo=docker&logoColor=white)

An app for making and keeping a chore schedule. See it hosted at [https://choreplan.truggeri.com](https://choreplan.truggeri.com)

## About the Application

This app is focused on household chores. Users can create chores, assign them a frequency in days, weeks or months and "perform" them to reset the next due clock. They can assign chores into custom categories as well.

## About Development

This app is written with Ruby on Rails. It was originally written to prove a fast proof-of-concept, but has since been refactored to follow better patterns such as [Draper Decorators](https://github.com/drapergem/draper), [MiniTest](https://guides.rubyonrails.org/testing.html) unit tests, seeds, and [Factory Bot factories](https://github.com/thoughtbot/factory_bot_rails). It is currently in a stable state.

## Running

```bash

bundle install

bundle exec rails server

```

### Dockerfile

There is an included Dockerfile that installs gems, copies relevant files and does an asset precomile. It doesn't use a mounted volume, so it's not ideal for local development, but it could quickly be modified to do so (this would enable live reloading of your code rather than rebuiding after every change). Build it with,

```bash

docker build --tag chore-schedule-app .

```

You can then run with a command like,

```bash

docker run --rm -p 3000:3000 -it -e DATABASE_URL=xxx chore-schedule-app:latest

```

## Tests

The test suite includes unit test for logic in models, helpers and decorators. It also includes some integration tests that exercise basic functionality in the controller logic. These tests aims to test many common paths that produces high test coverage, but this is not guarantee that the testing is exhaustive.

```bash

bundle exec rails test

```