Wildrent

---

Wildrent est une entreprise de location de matériel spécialisée dans les équipements tels que ski, randonnée, plongée, etc. Pour améliorer son efficacité opérationnelle, elle souhaite introduire une application web intuitive permettant la gestion des réservations et des stocks. Dans la première version, le MVP comprend des fonctionnalités telles que la connexion en tant qu'administrateur, la gestion des références produits et des stocks, la consultation des réservations, la recherche de produits disponibles, ainsi qu'un processus de commande convivial. Les évolutions futures incluent un dashboard avec des KPIs, l'intégration du paiement via Stripe, et une expansion internationale avec la traduction dans plusieurs langues et la gestion de multiples hubs de stockage. Cette initiative vise à soutenir la croissance rapide de l'entreprise, renforcée par une récente levée de fonds.

📝 Table of Contents

• About
• Getting Started
• Installing
• Deployment
• Usage
• Built Using
• Authors

🧐 About

This project is a web application for a rental company. It is a school project for the Wild Code School. The goal is to create a web application with a backend and a frontend. The backend is a GraphQL API with a PostgreSQL database. The frontend is a Next.js application with TailwindCSS and Radix UI.s

🏁 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. And see installation for notes on how to install the project on your machine for local development.

Prerequisites

Install Docker and Docker Compose on your machine. Install pnpm on your machine.

Installing

Check if Docker is installed on your machine:

docker --version

Check if Docker Compose is installed on your machine:

docker compose --version

Check if pnpm is installed on your machine:

pnpm --version

Clone the repository:

git clone https://github.com/WildCodeSchool/2023-09-wns-vert-groupe3.git

Go to the project "backend" folder or "frontend" folder:

cd backend

cd frontend

Install the dependencies:

pnpm install

---

Go to branch dev and create a new branch from it:

git checkout dev

git checkout -b <your-branch-name>

---

Run the containers:

docker compose up

Rebuild the containers and run them :

docker compose up --build

Watch applications files changes [and rebuilds on package.json changes] :

(La commande suivante est optionnelle, elle permet de surveiller les changements de fichiers et de reconstruire les conteneurs en cas de changement dans le fichier package.json)

[Cependant, si utilisée, il faut la lancer dans un autre terminal que celui où les conteneurs sont lancés (sans le couper) !!]

Bug connu : Sur windows, en watch mode, si le conteneur est arrêté et que plus tard on souhaite le relancer avec le watch mode, la commande docker compose watch peut renvoyer une erreur de ce type :

cannot take exclusive lock for project "<project name>": process with PID <pid> is still running

Pour régler ce problème, supprimer le contenu du dossier docker-compose situé dans : C:\Users\<user_name>\AppData\Local\docker-compose

Ce bug fait déjà l'object d'une issue sur le repo de docker : docker/compose#11066

docker compose watch

🎈 Usage

[TO COMPLETE]

🚀 Deployment

docker compose -f docker-compose.prod.yml up --build sur le système Linux

⛏️ Built Using

• Docker - Containerization
• Docker Compose - Containerization
• GraphQL - Query Language
• TypeORM - ORM
• Next.js 13 - Web Framework for frontend
• TailwindCSS - CSS Framework
• Radix UI - UI Components
• NodeJs - Server Environment

✍️ Authors

• [TO COMPLETE]