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 =

3. 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:

💻 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 🚀