GithubHelp home page GithubHelp logo

pokepi's Introduction

PokePI

GitHub contributors

Pokepi est une API restful qui permet à un utilisateur de créer son pokédex de pokémons

Features

  • Création, modification et suppression d'un compte utilisateur
  • Authentification sécurisée d'un utilisateur
  • Récupération des données d'un utilisateur connecté
  • Ajout de pokémons dans le pokédex de l'utilisateur connecté
  • Ajout d'un rate limiter à 20 requêtes toutes les minutes
  • Ajout d'un système de migrations et de fixtures disponibles au lancement du projet
  • Système de refresh token
  • Documentation des routes disponibles sur Swagger (en cours...)

Stack

  • typescript
  • express
  • ![mongodb]

Setup

  • Télécharger le code source
git clone https://github.com/SkynixFr/PokePI.git
  • Installer les dépendances
npm install
  • Initialisation de la connexion à la base de données :

Un fichier .exemple.env recense toutes les variables à compléter dans un fichier .env

  • Migrations

Un système de migration et de seed est disponible. Il permet d'initialiser la base de données, de la rendre à jour par rapport aux models et d'y ajouter des données factices.

Pour cela, 2 commandes sont à lancer avant le lancement du serveur :

npx prisma db pull
npm prisma db seed

Les données factices se trouvent dans le fichier : demo-client

  • Lancement du serveur
npm run dev

Alt Text

Contributeurs

pokepi's People

Contributors

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