Calyvim

Calyvim is an open-source task management tool built with Django and Vue.js, designed to help teams and individuals organize their work efficiently and effectively.

Features

• 📋 Intuitive task management
• 🏷️ Custom labels and categories
• 👥 Team collaboration
• 📅 Due date tracking
• 📊 Progress visualization
• 🔍 Advanced search and filtering
• 📱 Responsive design

Frontend Setup

1. Install dependencies:

   npm install

2. Run the development server:

   npm run serve

This will start the Vue.js development server, and you can access the frontend at http://localhost:5173.

Backend Setup

Prerequisites

Ensure you have the following installed:

• PostgreSQL
• Redis
• Python 3.8+

PostgreSQL Setup

1. Install PostgreSQL:

   Follow the instructions for your operating system from the official PostgreSQL documentation.

2. Create a database and user:

   CREATE USER calyvim WITH PASSWORD 'calyvim';
   CREATE DATABASE calyvim WITH OWNER calyvim;

Redis Setup

1. Install Redis:

   Follow the instructions for your operating system from the official Redis documentation.

2. Start Redis server:

   redis-server

Python Setup

1. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

2. Install dependencies:

   pip install -r requirements-dev.txt

Environment Setup

Copy environment variables:

```bash
cp .env.example .env
```

Django Setup

1. Set up the database:

   python manage.py migrate

2. Create a superuser:

   python manage.py createsuperuser

3. Run the development server:

   python manage.py runserver

Celery Setup

1. Start the Celery worker:

   celery -A calyvim worker -l INFO

This will set up the backend for your project. Add these sections below the "Frontend Setup" section in your README.md file. Let me know if you need any further modifications or if you're ready to proceed to the next section.

Contributing

We love contributions! Please read our Contributing Guide to get started.

Code of Conduct

Please read our Code of Conduct before contributing to the project.

Development Process

1. Fork the repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests (python manage.py test)
5. Commit your changes (git commit -m 'Add some amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Contributors

Thanks to all the amazing contributors who have helped make Calyvim better! ✨

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• 📫 Contact us at: [email protected]
• 🌟 Star us on GitHub
• 📢 Follow us on Twitter @calyvim