This project is a Valentine postcard website api written using FastAPI framework. Originally crafted as a surprise for my girlfriend on Valentine's Day, it started as a small index.html postcard landing.
Suddenly, when I first build landing postcard, I realized its potential to bring joy to others, prompting me to make it customizable for everyone to create their own unique postcards. The motivation behind this project to give people the ability to make their own customisable postcards.
To use this project, follow these direct commands:
-
Clone Repository:
git clone https://github.com/Lumberj3ck/valentiny_api -
Navigate to Project Directory:
cd valentiny_api -
Build docker container:
docker compose build -
Run Server:
docker compose up
You can run tests via:
pytest
Contributions to this project are welcome and encouraged. If you have ideas for improvements, new features, or bug fixes, feel free to submit a pull request. Here are some ways you can contribute:
- Fork the repository and make your changes.
- Create a new branch for your feature or fix.
- Make your modifications and ensure the codebase still functions correctly.
- Test your changes thoroughly.
- Submit a pull request, describing the changes you've made and why they're beneficial.