Wedding Invitation

A simple and elegant wedding invitation
built with Hugo, TailwindCSS, Python, and Next.js
Live Preview »

Report Bug · Request Feature

About The Project

TODO: this section

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Before you begin, make sure you have the following installed on your system:

• Frontend Requirements:

  • Hugo (Static Site Generator)
  • Node.js (Installing packages and TailwindCSS)
  • Python (Generating invitation pages)

• Backend Requirements:

  • Supabase credentials (for the Wishes API)

Installation

Frontend

1. Clone the Repository and navigate to the project directory:

   git clone https://github.com/odhyp/wedding-invitation.git && cd wedding-invitation

2. Install Frontend Dependencies:

   cd frontend && npm install

3. Fill data/guest.txt with guests name in each line

4. Run main.py

   python main.py

5. Voila! You can share the link to your guests using

   https://your-site.com/guest_name

Backend

1. To set up the Backend, navigate to backend directory and create a .env file with your credentials:

   cd backend

   SUPABASE_PASS=<Your_Supabase_Password>
   DATABASE_URL=<Your_Connection_Pooling_URL>
   DIRECT_URL=<Your_Direct_Connection_URL>

Usage

TODO: Fill this

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• Anggi Permata - Layout and Design
• Firdig Alfalakhi - Wishes API (Backend)