Table of Contents

• Collaborative Annual Planner
  • 🚀 Quick Start
  • ✨ Features
  • 📦 Dependencies
  • 📖 Usage
    • Architecture
  • 🗺️ Roadmap
  • ❤️ Contributing
  • 📜 License

Collaborative Annual Planner

A real-time, collaborative annual planner with no login required.

🚀 Quick Start

Get started with the Collaborative Annual Planner in just one command:

git clone https://github.com/javilopezg/calendar.git && cd calendar && npm install && npm run dev

Alternatively, you can use Docker:

docker run -p 8080:80 ghcr.io/javilopezg/calendar:main

✨ Features

• Real-time collaboration: See changes from other users instantly.
• No login required: Start planning right away without creating an account.
• Public modification: Anyone with the link can view or edit the calendar.
• Print-friendly: The user interface is optimized for A4 paper printing.
• Simple UX: A clean and intuitive interface that is easy to use.

📦 Dependencies

• React
• Vite
• Tailwind CSS
• Firebase
• Lucide React

📖 Usage

The Collaborative Annual Planner is designed to be simple and intuitive. Here are a few user stories to help you get started:

• As a project manager, I can create a new calendar for my team and share the link with them. Everyone can then add their tasks and deadlines to the calendar, and we can all see the project's progress in real-time.
• As a student, I can create a calendar for my study group. We can use it to track our assignments, exams, and other important dates.
• As a family, we can use the calendar to coordinate our schedules. We can add appointments, events, and other important information to the calendar so that everyone is on the same page.

Architecture

graph TD
    A[User] --> B{React App};
    B --> C[Firebase Firestore];
    C -- Real-time updates --> B;

🗺️ Roadmap

This is a weekend project, and future development depends on community interest. If you have any suggestions or feedback, please feel free to open an issue or submit a pull request.

• List all calendars the user owns
• Rediseign columns width for diferent media
• Change the URL to set the id
• Open by default the last calendar in wich the user was active
• Create new button
• Don't change event dates on year change
• Set optional time for events
• Strike oyt past events
• Show current month as first od the second column
• Allow go forward and backward over shown months

❤️ Contributing

Suggestions, help, and feedback are welcome! You can mail me or use discussions tab.

📜 License

This project is licensed under the BSD 3-Clause License. See the LICENSE file for details.