This is a simple greetings board application built with FastAPI, HTMX, and PostgreSQL. It allows users to post greetings with their GitHub avatars and messages.
- Real-time Updates: Greetings are added and updated without full page reloads, thanks to HTMX.
- GitHub Avatars: Users can easily add their GitHub avatars to their greetings.
- Tailwind CSS: The UI is styled using Tailwind CSS for a modern and customizable look.
- Dockerized: The app is containerized using Docker for easy development and deployment.
- Docker
- Docker Compose (if you want to run the database locally)
-
Clone the repository:
git clone [invalid URL removed]
-
Set up environment variables:
cp .env.example .env
-
Start the application:
docker-compose up -d
The application will be available at http://localhost:8000.
- Enter your GitHub ID in the form.
- Type your message in the message box.
- Click the "Post Greeting" button.
- Your greeting will appear on the board!
- Follow the instructions in the "Getting Started" section.
- You can use the included docker-compose.yaml file to start the application and database in development mode. The application will run with hot reloading, so changes to the code will be reflected automatically.
- Backend: FastAPI
- Frontend: HTML, HTMX, Tailwind CSS
- Database: PostgreSQL
- Containerization: Docker
- Use your preferred IDE (e.g., Visual Studio Code) with the Remote - Containers extension for a streamlined development environment.
- Edit the code, and the changes will be reflected live thanks to FastAPI's hot reloading.
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch (git checkout -b feature/your-feature-name).
- Make your changes and commit them (git commit -m 'Add some feature').
- Push to the branch (git push origin feature/your-feature-name).
- Create a pull request.
This project is licensed under the MIT License.