Giter Club home page Giter Club logo

bibliotech's Introduction

BiblioTech

Índice

Sobre   |    Pré-Requisitos   |    Como Rodar   |    Licença

📖 Sobre

Bibliotech é um app simples em que você pode salvar os livros que você mais gosta.


Pré-requisitos

  • É necessário possuir o Node.js instalado na máquina
  • Também, é preciso ter um gerenciador de pacotes seja o Yarn.
  • Por fim, é essencial ter uma instancia do PostgreSQL rodando na sua maquina.

Caso tenha o Docker Desktop instalado basta usar esse comando pra iniciar um container com uma instancia do PostgreSQL:

docker run --name nlw -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres


👷 Como rodar

🔗 Clonando repositório

# Clone o repositorio
$ git clone https://github.com/AlexSRH/BiblioTech.git

⚙️ Configurando ambiente

  1. Crie um database com o nome bibliotech na sua instancia do PostgreSQL.
  2. Entre na pasta backend, copie o conteúdo das variáveis de ambiente no arquivo .env.example, crie um novo arquivo chamado .env e cole o conteúdo.
# Database configs
DB_PORT = 5432
DB_HOST =
DB_USER =
DB_PASSWORD =

# Secret token
APP_SECRET =
  1. Crie um arquivo chamado .env e coloque as variáveis do seu ambiente
    • DB_PORT - Porta do banco de dados
    • DB_HOST - Host do banco de dados
    • DB_USER - Usuário do banco de dados
    • DB_PASSWORD - Senha do banco de dados
    • APP_SECRET - Token para criptografia do JWT(Pode colocar qualquer coisa sem espaço)

📦 Rode a API (Backend)

# Vá para a pasta do servidor
$ cd BiblioTech/backend

# Instale as depedencias
$ yarn

# Rode as migrations
$ yarn typeorm migration:run

# Rode o ambiente de desenvolvimento da API
$ yarn dev

A api vai rodar na porta 3333 por padrão. Caso queira mudar a porta Clique aqui

Você pode ver as rotas disponíveis e testa-las no Insomnia:

Run in Insomnia}

💻 Rode o Projeto Web (Frontend)

# Vá para a pasta frontend
$ cd BiblioTech/frontend

# Instale as depedencias
$ yarn

# Rode a aplicação
$ yarn start

Acesse: http://localhost:3000/ para ver o resultado.


📕 License

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.


Feito com amor por Alexsandro G Bezerra 🚀

bibliotech's People

Contributors

alexsrh avatar

Stargazers

 avatar

Watchers

 avatar

bibliotech's Issues

Tarefas

  • Especificar tarefas;

Backend

  • Receber dados de um novo usuário e salvar no banco de dados;
    • Validação de dados;
    • Criptografar senha;
  • Receber dados de um usuário para autenticação e responder com um token JWT;

Rotas autenticadas (Precisam de um token JWT)

  • Receber dados de um novo livro, e salvar os dados no banco de dados;
  • Responder a lista de livros do usuário;
  • Receber id de um livro e excluir do banco de dados;

Frontend(Telas)

  • Login - 2 inputs(email e senha) e um link para tela de Cadastro;
  • Cadastro - 3 inputs(nome, email e senha) e botão de voltar para tela de Login;
  • Dashboard - Saudações, lista de livros, botão de Log-out e botão de adicionar novos livros;
    • Modal com detalhes de um livro, e a possibilidade de remoção do mesmo;
  • Tela de registro de novo livro;

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.