tududi/README.md
2023-11-13 13:34:38 +02:00

3 KiB

tu | du | di

tu|du|di is a task and project management web application built with Sinatra. It allows users to efficiently manage their tasks and projects, categorize them into different areas, and track due dates. tu|du|di is designed to be intuitive and easy to use, providing a seamless experience for personal productivity.

image

Features

  • Task Management: Create, update, and delete tasks. Mark tasks as completed and view them by different filters (Today, Upcoming, Someday).
  • Project Tracking: Organize tasks into projects. Each project can contain multiple tasks.
  • Area Categorization: Group projects into areas for better organization and focus.
  • Due Date Tracking: Set due dates for tasks and view them based on due date categories.
  • Responsive Design (in progress): Accessible from various devices, ensuring a consistent experience across desktops, tablets, and mobile phones.

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Ruby (version 3.2.2 or higher)
  • Sinatra
  • SQLite3
  • Puma

Installation

To install tu|du|di, follow these steps:

  1. Clone the repository:
    git clone https://github.com/chrisvel/tududi.git
    
  2. Navigate to the project directory:
    cd tududi
    
  3. Install the required gems:
    bundle install
    

SSL setup

  1. Create and enter the directory:

    mkdir certs
    
  2. Navigate to the certs directory:

    cd certs
    
  3. Create the key and cert:

    openssl genrsa -out server.key 2048
    openssl req -new -x509 -key server.key -out server.crt -days 365
    

DB setup

  1. Execute the migrations

    rake db:migrate 
    

Create your user

  1. Open console

    rake console
    
  2. Add the user

    User.create(email: "myemail@somewhere.com", password: "awes0meHax0Rp4ssword")
    

Usage

To start the application, run the following command in your terminal:

puma -C app/config/puma.rb

Testing

To run tests:

bundle exec ruby -Itest test/test_app.rb

Open your browser and navigate to http://localhost:9292 to access the application and login with the email and the password you created.

Contributing

Contributions to tu|du|di are welcome. To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/AmazingFeature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some AmazingFeature').
  5. Push to the branch (git push origin feature/AmazingFeature).
  6. Open a pull request.

License

This project is licensed under the MIT License.

Contact

If you have any questions or comments about tu|du|di, please feel free to open an issue or contact the developer directly.


README created by Chris Veleris for tu|du|di.