Giter Club home page Giter Club logo

playgo-api's Introduction

API do app Play-GO

Installing

  1. Clone this repository. $ git clone <repo_link>
  2. Go to the project folder. $ cd <repo_folder>
  3. Copy environment file $ cp .env.example .env and included values
  4. Copy environment docker file $ cp .env.docker.example .env.docker and included values
  5. Run $ nvm use
  6. Install the dependencies. $ npm install

Execute

  1. Run DB using docker compose. $ docker-compose --env-file=.env.docker up -d
  2. Run the server. $ npm run dev
  3. Run Jest Tests $ npm run test

Documentation

  1. Access Swagger http://localhost:{portNumber}/api-docs

Configure pgAdmin

  1. Get Docker postgres_contaier IP address $ docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' postgres_container and changed DB_HOST variable in .env
  2. Access: http://localhost:5050/
  3. Create the server according to your environment variables

Access RabbitMQ

  1. Get Docker rabbitmq IP address $ docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' rabbitmq_management and changed RABBITMQ_HOST variable in .env
  2. Access: http://localhost:15672/

Migrations

  1. Create migration: $ npm run create:migrate
  2. Run migrations: $ npm run migrate

playgo-api's People

Contributors

lmqs avatar

Stargazers

Jeoflan Junior 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.