Code Monkey home page Code Monkey logo

project-diffusion-backend's Introduction

Projeto Diffusion - Backend

Bem-vindo (a) ao repositório do Projeto Diffusion (Backend).

Contexto

Esta API permite criar e autenticar pessoas usuárias, criar, editar e deletar posts.

Tecnologias utilizadas no desenvolvimento

Typescript, Node, Sequelize, Docker.

Documentação

Para acessar a documentação da API basta acessar o seguinte endereço, estando ela rodando:

http://localhost:3001/api-docs/

Dependências necessárias

Para rodar este projeto é necessário ter instalado na máquina o Docker e Docker Compose ou o npm.

Rodando a aplicação

Possuindo as dependências necessárias na máquina, siga as intruções abaixo:

Rodando a aplicação com Docker Compose
  1. Para rodar a aplicação com o Docker Compose, digite o comando abaixo no terminal:
  docker-compose up
  1. Agora, copie as informações do arquivo .env.example para um arquivo .env

  2. Feito isso, faça o reset do banco rodando o seguinte comando:

  npm run db:reset
  1. Pronto! A API já está pronta para uso local.
Rodando a aplicação sem Docker

Para rodar a aplicação sem o Docker Compose:

Certifique-se de possuir um banco de dados MySql rodando em segundo plano com as configurações indicadas no arquivo .env.example (nome, host, usuário e senha).

  1. Instale as dependências do projeto:
  npm install
  1. Inicie o servidor:
  npm start
  1. Agora, copie as informações do arquivo .env.example para um arquivo .env

  2. Feito isso, faça o reset do banco rodando o seguinte comando:

  npm run db:reset
  1. Pronto! A API já está pronta para uso local.

project-diffusion-backend's People

Contributors

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