Giter VIP home page Giter VIP logo

raccourci's Introduction

img License


Raccourci - URL shortener

Installation

Pour débuter, l'installation des packages nodejs est faite par la commande npm:

$ npm install

Ensuite, pour déployer l'application, il faut créer un fichier .env dans la racine de l'application, et reinseigner le contenu ci-dessous:

# Variables d'environnement
APP=raccourci
SUFFIX=dev
NETWORK=raccourci-network
MODE=DEV
SECRET=

# Variables d'environnement de la bd MySQL
MYSQL_HOST=raccourci-db
MYSQL_PORT=3307
MYSQL_ROOT_PASSWORD=
MYSQL_USER=port-e-user
MYSQL_PASSWORD=
MYSQL_DATABASE=raccourci

# TypeORM 
# Dans les environnements de developpement et d'acceptation, setter à true 
# IMPORTANT: POUR L'ENVIRONNEMENT DE PROD, SETTER À false!!!!! Sinon on risque la perte de données à la prod. 
SYNCHRONIZE=true

Executer l'application

Pour exécuter le projet localement, utiliser les commandes ci-dessous:

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Le cas d'utilisation plus commun, par contre, sera via container docker. Pour exécuter le projet contenairisé, utiliser les commandes ci-dessous:

# À la première utilisation, ou après les modifications:  
$ docker-compose build 

# Ensuite, démarrer l'application:
$ docker-compose up 

Pour arrêter l'application:

$ docker-compose stop 

Remove les containers (ensuite, il sera obligatoire refaire le build des containers):

$ docker-compose down 

Création du record raccourci

Une fois que l'application est deployée, il faut accéder à la fonctionalité de création de record via Swagger API (http://www.lien...)

À l'endpoint POST /short-url, coller le payload suivant pour la création de l'url

{
    "originalUrl": "https://www.long-url-qui-sera-diminue",
    "uniqueId": "", 
    "numberClicks": 0, 
    "user": "nomdelusager"
}

raccourci's People

Contributors

juliozohar avatar torjc01 avatar

Watchers

 avatar  avatar  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.