Christmas Gifts Planner

---

Christmas gift planner is a collaborative platform designed to facilitate the sharing of gift ideas among family members or groups of friends while maintaining the element of surprise.

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

🧐 About

Our project, Christmas Gifts Planner, is a collaborative effort by a team of 4 individuals undergoing training as web developer designers. The project aims to facilitate members of a family or group of friends to discuss gift ideas without seeing what others are preparing for them. A dedicated discussion thread would be allocated to each member, enabling other members to exchange individual or collective gift ideas.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Before you begin, ensure you have met the following requirements:

Docker installed
Node.js installed
PostgreSQL installed

Installing

1. Clone the repository:

git clone https://github.com/WildCodeSchool/2023-11-wns-bleu-g2.git

2.Navigate to the project directory:

cd backend

3. Create a .env file in the root directory and fill it with necessary environment variables:

# Example .env file
DATABASE_URL=postgres://username:password@localhost:5432/database_name

4.Start the development server with Docker Compose:

docker-compose up --build

5.Open your browser and navigate to http://localhost:3000 to view the application.

🔧 Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

🎈 Usage

Add notes about how to use the system.

🚀 Deployment

Add additional notes about how to deploy this on a live system.

⛏️ Built Using

• GraphQL - Query Language
• Apollo Server - GraphQL Server
• NodeJs - Server Environment
• PostgreSQL - Database
• TypeORM - ORM for TypeScript
• Next.js - React Framework
• React - JavaScript Library
• Apollo Client - GraphQL Client
• Docker - Containerization Platform

✍️ Authors

• @AlexandreRichert - Idea & Initial work
• @alon-bendavid - Idea & Initial work
• @Fangornito - Idea & Initial work
• @Jasminegrz - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References