Code Monkey home page Code Monkey logo

piiquante's Introduction

Piiquante

ImageWebsite

English

(cliquez sur ce lien pour vous rendrez directement à la version française)

This work is the 6th project of OpenClassrooms Web Developer training.
This repo contains the backend of Hot Takes web app. Hot Takes is an application, developped for the brand Piiquante, that allows users to upload and rate spicy sauces.

Requirements

To get this project to work, you should have the following program installed :

➡️ Node V18.12+ (you can download it on Node Website)

How to install

1️⃣ Create a folder for this project

2️⃣ Clone via the following link the frontend Repo into a frontend folder

3️⃣ Clone this repo into a backend folder

4️⃣ Open a terminal and go to your frontend folder,

cd frontend

then type the following instructions :

npm install
npm start

The frontend will run on http://localhost:4200

5️⃣ Open a second terminal and go to your backend folder,

cd backend

then type the following instructions :

npm install
nodemon server

The backend will run on http://localhost:3000

6️⃣ Create a .env file in the root of the projet (for security reason, the real file isn't on this repo, you'll have to create your one)

touch .env

7️⃣ Set the MongoDB Database : Create a cluster on MongoDb, then an user (please keep the password). Go in Network Access and select "Add IP Adress", then : "Add access from Anywhere"

8️⃣ Copy the text in env.example file and paste it your own .env file. Then change the MONGODB_URI by your own connect link (accessible from "Connect", then "Connect your application"). Please make you replace the username and password by your own.

9️⃣ Change the JWT_SECRET_TOKEN by your own Token (make sure it's complex enough).

You're all set !


Français

(click on the link to go directly to the english version)

Ce travail a été réalisé pour le Projet 6 de la formaiton Développeur Web d'OpenClassrooms.
Ce repo contient uniquement le backend de l'application web Hot Takes. Hot Takes est une application, développée pour la marque de sauces Piiquante, qui propose aux utilisateurs de télécharger et de noter des sauces piquantes.

Pré-requis

Pour faire fonctionner ce projet, vous devez installer le programme suivant :

➡️ Node V18.12+ (vous pouvez le télécharger sur le site de Node)

Installation

1️⃣ Créez un dossier pour ce projet

2️⃣ Clonez, via le lien suivant, le repo frontend dans un dossier frontend

3️⃣ Clonez ce repo dans un dossier backend

4️⃣ Ouvrez un terminal et positionnez-vous dans votre dossier frontend,

cd frontend

puis tapez les instructions suivantes :

npm install
npm start

Le frontend s'exécutera sur http://localhost:4200

5️⃣ Ouvrez un deuxième terminal et positionnez-vous dans votre dossier backend,

cd backend

puis tapez les instructions suivantes :

npm install
nodemon server

The backend s'exécutera sur http://localhost:3000

6️⃣ Créez un fichier .env à la racine du fichier (pour des raisons de sécurité, le fichier que j'ai utilisé ne figure pas sur ce repo, vous devrez le créer)

touch .env

7️⃣ Paramétrez votre base de données MongoDB : créez un cluster, puis un utilisateur (pensez à conserver le mot de passe). Ensuite, allez sur Network Access et sélectionnez "Add IP Adress", puis : "Add access from Anywhere"

8️⃣ Copiez le texte présent dans le fichier env.example and collez le dans votre propre fichier .env. Ensuite, changer la valeur de MONGODB_URI par votre propre lien de connexion(accessible depuis "COnnect" puis "Connect your application"). Pensez également à remplacer les termes username et password par vos propres données.

9️⃣ Changez le JWT_SECRET_TOKEN par un token de votre choix.

Tout est bon !

piiquante's People

Contributors

patariom avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.