Secret Santa App

Description

Cette application Next.js permet de gérer plusieurs évènements de pères noël secret, de tirer au sort des pères noël secret entre les participant·es et de renseigner une liste de cadeaux souhaités pour chaque évènement.

Installation

Prérequis

• Node.js (v20 ou supérieur)
• npm ou yarn

Instructions

1. Clonez le dépôt : git clone https://github.com/ShayReichert/super-secret-santa-front.git
2. Naviguez dans le dossier du projet : cd super-secret-santa-front
3. Installez les dépendances : npm install ou yarn install

Configuration

1. Créez un fichier .env.local à la racine du projet et ajoutez-y vos variables d'environnement (voir .env.production pour un exemple).

Lancer l'application

1. Démarrez le serveur de développement : npm run dev ou yarn dev
2. Ouvrez http://localhost:3000 pour voir le résultat dans votre navigateur.

Backend

Le backend de cette application est disponible ici. Assurez-vous de suivre les instructions pour installer et configurer le backend.

Utilisation

1. Naviguez sur l'interface utilisateur pour tester l'app. Créez un compte, créez un évènement et renseignez des cadeaux souhaités.
2. Cliquez sur "Faire le tirage au sort" pour attribuer des pères noël secrets à chaque participant·e.

Contribution

Nous sommes ouverts aux contributions ! Pour contribuer :

1. Forkez le projet.
2. Créez une branche pour votre fonctionnalité : git checkout -b ma-nouvelle-fonctionnalite
3. Faites vos modifications et commit : git commit -m 'Ajout d'une nouvelle fonctionnalité'
4. Poussez vos modifications : git push origin ma-nouvelle-fonctionnalite
5. Ouvrez une pull request.

Licence

Ce projet est sous licence MIT.

---

ENGLISH VERSION

Secret Santa App

Description

This Next.js application allows you to manage several secret Santa events, to draw lots for secret Santas between participants and to enter a list of desired gifts for each event.

Facility

Prerequisites

• Node.js (v20 ou supérieur)
• npm or yarn

Instructions

1. Clone the repository: git clone https://github.com/ShayReichert/super-secret-santa-front.git
2. Navigate to the project folder: cd super-secret-santa-front
3. Install dependencies: npm install or yarn install

Setup

1. Create a .env.local file in the root of the project and add your environment variables to it (see .env.production for an example).

Launch the application

1. Start the development server: npm run dev or yarn dev
2. Open http://localhost:3000 to see the result in your browser.

##Backend

The backend of this application is available here. Make sure to follow the instructions to install and configure the backend.

Use

1. Navigate the user interface to test the app. Create an account, create an event and enter desired gifts.
2. Click on “Draft” to assign secret Santas to each participant.

Contribution

We are open to contributions! To contribute:

1. Fork the project.
2. Create a branch for your feature: git checkout -b my-new-feature
3. Make your changes and commit: git commit -m 'Added a new feature'
4. Push your changes: git push origin my-new-feature
5. Open a pull request.

Licence

This project is under the MIT license.