ToDo App

A simple web application to manage checklists and tasks.

Table of Contents

• Features
• Requirements
• Setup
• Development
• Feedback
• Contributing
• License

Features

• Simple landing page

• User registration and secure authentication (strong password validation)

• Option to enable/disable Two Factor Authentication using OTP

• Checklists management - create, update or delete

• Tasks management - create, update, delete

• Option to move task on checklist using drag&drop

• Option to upload thumbnail for checklist

• Option to export checklist as PDF file

• Option to send checklist via email

Tools

• Ruby 3.2.2
• Node 20.9.0
• TypeScript 5.5.4
• Rails 7.2.1
• Vue 3.4.38
• Vite 5.0.0
• TailwindCSS 3.4.10

Setup

1. Install application dependencies

bundle install
yarn install

2. Create and setup the database

bundle exec rake db:create
bundle exec rake db:setup

3. Start dev servers

# run rails and vite servers
bin/dev

Development

# RSpec
bundle exec rspec

# Rubocop
bundle exec rubocop

# Vitest
yarn run test

# TypeScript Check
yarn run ts:check

# ESlint
yarn run eslint

Feedback

Feel free to send us feedback. Feature requests are always welcome. If you wish to contribute, please take a quick look at the guidelines!

If you notice any bugs in the app, see some code that can be improved, or have features you would like to be added, please create a bug report or a feature request!

A good bug report must include the following four things:

1. The steps to reproduce the bug: Give detailed steps on how to reproduce the problem
2. The expected behavior of the application: It’s important to include the result you’re expecting, as it might differ from how the program was designed to work.
3. The observed behavior of the application
4. Additional info: ... like some links, images etc.

Contributing

We encourage you to contribute to ToDo App! See CONTRIBUTING for guidelines about how to proceed.

Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request.

If you want to open a PR that fixes a bug or adds a feature, then we can't thank you enough! It is definitely appreciated if an issue has been created before-hand so it can be discussed first.

License

ToDo App is released under the MIT license.