Welcome to the Wedding Backend, the backbone for my wedding website. Built with Python and FastAPI, this API allows to register guest digitally.
-
User Registration & Management: Endpoints to handle user registration, email verification, login, password recovery, and password reset. 📇
-
Guest Management: Easily manage wedding guest list, from adding guest information to retrieving it, ensuring you have all the details needed for your big day. 🧑🤝🧑
-
Contact Form: A dedicated endpoint to handle messages sent through the contact form on your wedding website, including background email sending functionality. 📧
-
Security: Utilizes HTTP Bearer tokens for authentication, ensuring that user and guest information is protected throughout the planning process. 🔐
To get started with the Wedding Backend, follow these steps:
- Install docker
- Clone the repository to your local machine or server.
- Customize configuration by adding
config/config.json - Build docker container by running
docker build -t wedding-backend . - Run docker container by running
docker run --name wedding-backend wedding-backend
GET /ping: Returns{'message': 'pong'}to indicate the API is running.
POST /user-register: Register a new user.POST /email-verification: Verify the user's email address.POST /login: Authenticate a user.POST /forget-password: Initiate a password reset process.POST /reset-password: Reset a user's password.
GET /guest-info: Retrieve information about the guests.POST /guest-info: Update guest information.
GET /contact_info: Retrieve contact information.POST /send_message: Send a message through the contact form.
To ensure a consistent development environment, a devcontainer configuration is provided.
python -m smtpd -c DebuggingServer -n localhost:1025
Contributions are welcome! If you'd like to improve the Wedding Planner API or add new features, please feel free to fork the repository, make your changes, and submit a pull request.
If you encounter any issues or have questions, please submit an issue on the GitHub repository.
Embrace the journey to your special day with the Wedding Backend. 💒🎉