Skip to content

hugofolloni/wedding-gifts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

wedding-gifts 🎁

Description πŸ“

wedding-gifts is a comprehensive web application with an API designed to streamline wedding gift management. Couples can easily add gifts to the list and track who has chosen to purchase each item. Guests have access to an organized list of gifts, allowing them to choose, purchase, and pay via an automatically generated PIX code.

Technologies Used πŸ’»

  • Front-end: React, TypeWriter, MD5 Encryption
  • Back-end: Node.js, Express, PostgreSQL, PixJS, dotenv
  • Database: PostgreSQL, legacy version in MySql

Installation Instructions πŸ› οΈ

  1. Clone the git repository:
    git clone https://github.com/your-username/wedding-gifts.git
  2. Front-end:
    cd wedding-gifts/website
    npm i
    npm start
  3. Back-end:
    • Generate a PostgreSQL database and update the information in the .env file inside the server folder.
    • Run the table creation scripts available in the database.js file inside the server/api folder.
    cd wedding-gifts/server
    npm i
    npm start

How to Use πŸŽ‰

For Guests πŸ‘°πŸ€΅

  1. Browse the beautiful and delicate layout.
  2. Analyze the list of gifts and choose what you want to buy.
  3. Click on the chosen gift to purchase.
  4. Enter your name to be added to the list of buyers.
  5. Complete the payment using the automatically generated PIX code.

For Couples πŸ‘°πŸ€΅

  1. Access the /admin tab to add new gifts.
  2. Monitor the list of buyers for each gift.

API Endpoints 🌐

  • /gifts: Returns all registered gifts.
  • /buyers: Returns the buyers for each gift.

Live Version

This project can be found at the following URLs:

System Requirements πŸ“‹

  • Node.js installed

Contribution 🀝

Feel free to contribute to the project! Just fork the repository, implement your improvements, and submit a pull request.

License πŸ“œ

This project is under the MIT license.

Contact πŸ“ž

For support or to report issues, please contact us via email: hugofollogua07@gmail.com

About

🎁 A web app and API for easy wedding gift management.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages