158 lines
4.5 KiB
Markdown
158 lines
4.5 KiB
Markdown
# 📝 tududi
|
||
|
||
`tududi` is a task and project management web application that allows users to efficiently manage their tasks and projects, categorize them into different areas, and track due dates. It is designed to be intuitive and easy to use, providing a seamless experience for personal productivity.
|
||
|
||
|
||
|
||
|
||
|
||
## 🚀 How It Works
|
||
|
||
This app allows users to manage their tasks, projects, areas, notes, and tags in an organized way. Users can create tasks, projects, areas (to group projects), notes, and tags. Each task can be associated with a project, and both tasks and notes can be tagged for better organization. Projects can belong to areas and can also have multiple notes and tags. This structure helps users categorize and track their work efficiently, whether they’re managing individual tasks, larger projects, or keeping detailed notes.
|
||
|
||
## ✨ Features
|
||
|
||
- **Task Management**: Create, update, and delete tasks. Mark tasks as completed and view them by different filters (Today, Upcoming, Someday). Order them by Name, Due Date, Date Created, or Priority.
|
||
- **Quick Notes**: Create, update, delete, or assign text notes to projects.
|
||
- **Tags**: Create tags for tasks and notes to enhance organization.
|
||
- **Project Tracking**: Organize tasks into projects. Each project can contain multiple tasks and/or multiple notes.
|
||
- **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**: Accessible from various devices, ensuring a consistent experience across desktops, tablets, and mobile phones.
|
||
|
||
## 🗺️ Roadmap
|
||
|
||
Check out our [GitHub Project](https://github.com/users/chrisvel/projects/2) for planned features and progress.
|
||
|
||
## 🛠️ Getting Started
|
||
|
||
### Prerequisites
|
||
|
||
Before you begin, ensure you have the following installed:
|
||
- Ruby (version 3.2.2 or higher)
|
||
- Sinatra
|
||
- SQLite3
|
||
- Puma
|
||
- ReactJS
|
||
|
||
### 🏗 Installation
|
||
|
||
To install `tududi`, follow these steps:
|
||
|
||
1. Clone the repository:
|
||
```bash
|
||
git clone https://github.com/chrisvel/tududi.git
|
||
```
|
||
2. Navigate to the project directory:
|
||
```bash
|
||
cd tududi
|
||
```
|
||
3. Install the required gems:
|
||
```bash
|
||
bundle install
|
||
```
|
||
|
||
### 🔒 SSL Setup
|
||
|
||
1. Create and enter the directory:
|
||
```bash
|
||
mkdir certs
|
||
cd certs
|
||
```
|
||
2. Create the key and cert:
|
||
```bash
|
||
openssl genrsa -out server.key 2048
|
||
openssl req -new -x509 -key server.key -out server.crt -days 365
|
||
```
|
||
|
||
### 📂 Database Setup
|
||
|
||
Execute the migrations:
|
||
|
||
```bash
|
||
rake db:migrate
|
||
```
|
||
|
||
### 👤 Create Your User
|
||
|
||
1. Open the console:
|
||
```bash
|
||
rake console
|
||
```
|
||
2. Add the user:
|
||
```ruby
|
||
User.create(email: "myemail@somewhere.com", password: "awes0meHax0Rp4ssword")
|
||
```
|
||
|
||
### 🚀 Usage
|
||
|
||
To start the application, run:
|
||
|
||
```bash
|
||
puma -C app/config/puma.rb
|
||
```
|
||
|
||
### 🐋 Docker
|
||
|
||
Pull the latest image:
|
||
|
||
```bash
|
||
docker pull chrisvel/tududi:0.20
|
||
```
|
||
|
||
Set up the necessary environment variables:
|
||
|
||
- `TUDUDI_USER_EMAIL`
|
||
- `TUDUDI_USER_PASSWORD`
|
||
- `TUDUDI_SESSION_SECRET`
|
||
- `TUDUDI_INTERNAL_SSL_ENABLED`
|
||
|
||
1. (Optional) Create a random session secret:
|
||
```bash
|
||
openssl rand -hex 64
|
||
```
|
||
|
||
2. Run the Docker container:
|
||
```bash
|
||
docker run \
|
||
-e TUDUDI_USER_EMAIL=myemail@example.com \
|
||
-e TUDUDI_USER_PASSWORD=mysecurepassword \
|
||
-e TUDUDI_SESSION_SECRET=your_generated_hash_here \
|
||
-e TUDUDI_INTERNAL_SSL_ENABLED=false \
|
||
-v ~/tududi_db:/usr/src/app/tududi_db \
|
||
-p 9292:9292 \
|
||
-d chrisvel/tududi:latest
|
||
```
|
||
|
||
3. Navigate to [https://localhost:9292](https://localhost:9292) and login with your credentials.
|
||
|
||
### 🔍 Testing
|
||
|
||
To run tests, execute:
|
||
|
||
```bash
|
||
bundle exec ruby -Itest test/test_app.rb
|
||
```
|
||
|
||
## 🤝 Contributing
|
||
|
||
Contributions to `tududi` 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 for free personal use, with consent required for commercial use. Refer to the LICENSE for further details.
|
||
|
||
## 📬 Contact
|
||
|
||
For questions or comments, please [open an issue](https://github.com/chrisvel/tududi/issues) or contact the developer directly.
|
||
|
||
---
|
||
|
||
README created by [Chris Veleris](https://github.com/chrisvel) for `tududi`.
|