Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andreasthinks/fastcalendar
A collaborative web calendar built using FastHTML
https://github.com/andreasthinks/fastcalendar
calendar fasthtml python webapp
Last synced: 5 days ago
JSON representation
A collaborative web calendar built using FastHTML
- Host: GitHub
- URL: https://github.com/andreasthinks/fastcalendar
- Owner: AndreasThinks
- License: mit
- Created: 2024-09-21T11:22:27.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T23:24:24.000Z (15 days ago)
- Last Synced: 2024-10-30T01:51:37.192Z (15 days ago)
- Topics: calendar, fasthtml, python, webapp
- Language: Python
- Homepage:
- Size: 375 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastCalendar
FastCalendar is a lightweight, customizable web-based calendar application built with FastHTML. It's designed to be easily deployed directly from a GitHub repository, allowing event submissions via Pull Requests. This makes it ideal for community-driven event calendars or personal event tracking.
A live version can be viewed at https://tech-for-good.events/
## Features
- Interactive calendar view with month navigation
- Agenda view for upcoming events
- Location-based event filtering
- RSS feed for event subscriptions
- Customizable title and about section
- Social media links integration
- Static logo display
- Markdown support for event descriptions and about section
- Easy event submission via GitHub Pull Requests
## Technology Stack
- Python 3.11+
- FastHTML
- SQLite
- YAML for configuration and event data
## Prerequisites
- Python 3.11+
- uv
## Installation
1. Clone the repository:
```
git clone https://github.com/your-username/awesome-calendar.git
cd awesome-calendar
```
2. Create and activate a virtual environment:
```
uv venv --python 3.11
```
3. Install the required packages:
```
uv sync
```
4. Create a `custom_settings.yaml` file in the project root with the following structure:
```yaml
title: My Awesome Calendar
about_content: |
# About
This is my awesome calendar application.
## Features
- Easy to use
- Customizable
- Markdown support
website_url: https://example.com
github_url: https://github.com/your-username/awesome-calendar
default_locations:
- Online
- London
social_links:
- name: RSS
url: /rss
icon: rss-simple
- name: Discord
url: https://discord.gg/your-server
icon: discord-logo
```
5. Create an `events.yaml` file in the project root to populate your calendar with events:
```yaml
- id: 1
title: Team Meeting
date: 2024-09-15
description: |
# Weekly Team Sync-up
## Agenda
- Project updates
- Upcoming deadlines
- Q&A session
Join us at [Google Meet](https://meet.google.com/abc-defg-hij)
url: https://meet.google.com/abc-defg-hij
location: Online
- id: 2
title: Project Deadline
date: 2024-09-30
description: |
**Final submission for Q3 project**
Make sure to:
- Complete all deliverables
- Review documentation
- Prepare presentation slides
url: ""
location: London
```
6. Add your logo image file (e.g., `logo.png`) to the `static` folder in the project root.
## Usage
1. Run the application:
```
python main.py
```
2. Open a web browser and navigate to `http://localhost:5001` (or the port specified in your configuration).
3. Use the calendar view to browse events, switch to the agenda view, or filter events by location.
4. Click on events to view details. Event descriptions support Markdown formatting.
5. Use the social media buttons in the footer to access linked platforms or subscribe to the RSS feed.
## Customization
- Modify the `custom_settings.yaml` file to change the application title, about content, website URL, GitHub URL, default locations, and social media links.
- Edit the `events.yaml` file to add, remove, or modify events. Event descriptions support Markdown formatting.
- Replace the `logo.png` file in the `static` folder to change the application logo.
## Deployment
FastCalendar is designed to be deployed directly from a GitHub repository. You can use services like Vercel, Netlify, or GitHub Pages for easy deployment. Specific deployment instructions will depend on your chosen platform.
## Submitting Events
To submit a new event:
1. Fork the repository
2. Add your event to the `events.yaml` file
3. Create a Pull Request with your changes
The repository maintainer will review and merge your PR, updating the calendar.
## Updating the Application
To update the application or event data:
1. Pull the latest changes from the main repository
2. Update your `custom_settings.yaml` or `events.yaml` as needed
3. Redeploy your application
## Current Limitations
- Location names: The current version of FastCalendar only supports single-word location names. Multi-word location names may not function correctly for filtering and display purposes. We're working on improving this in future updates.
## Troubleshooting
If you encounter any issues:
- Ensure all dependencies are correctly installed
- Check that your `custom_settings.yaml` and `events.yaml` files are correctly formatted
- Verify that your Python version is 3.11 or higher
- Remember that location names should be single words
For more help, please open an issue on the GitHub repository.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.