O AgendeAqui é um projeto desenvolvido para fazer um agendamento entre o prestador de serviços e o cliente. Utilizando as tecnologias Typescript, React, NodeJs, Prisma, Fastify e NextJS.
O projeto tem como finalidade disponibilizar uma página na web onde o cliente pode agendar um serviço. Ali, o cliente poderá escolher os horários disponíveis.
Front-End (React + TypeScript)
- Next.js
- HTML
- TAILWIND CSS
Back-End (NodeJs + TypeScript)
- Protótipo: Figma → Protótipo (AgendeAqui)
- Ícones: React-Icons
Primeiro, você precisa ter o NodeJS instalado na sua máquina.
Se você estiver utilizando o Linux, você pode optar por instalar o Node através do gerênciador de versões nvm para facilitar o processo de mudança da versão do Node, quando for necessário.
Você pode optar também por utilizar o yarn no lugar do npm. Você pode instalar clicando neste link.
Após ter o Node instalado, instale as dependências do React instale as dependências contidas nos arquivos package.json
que se encontram na raíz do repositório (para o gerenciamento de commits), no diretório do projeto. Para instalar as dependências, basta abrir o terminal no diretório e digitar o comando:
$ yarn
ou
$ npm install
Neste tutorial, você aprenderá a configurar um container Docker PostgreSQL utilizando as seguintes instruções.
Para começar, você precisa fazer o pull da imagem Docker oficial do PostgreSQL.
$ docker pull postgres
Agora, você pode criar e executar um container PostgreSQL com as configurações desejadas.
$ docker run --name my-postgres -p 5432:5432 -e POSTGRES_DB=teste -e POSTGRES_USER=user -e POSTGRES_PASSWORD=mypassword -d postgres
Neste comando:
--name my-postgres: Define o nome do container como "my-postgres".
-p 5432:5432: Mapeia a porta 5432 do host para a porta 5432 do container.
-e POSTGRES_DB=teste: Define o nome do banco de dados como "teste".
-e POSTGRES_USER=user: Define o nome de usuário como "user".
-e POSTGRES_PASSWORD=mypassword: Define a senha do usuário como "mypassword".
-d postgres: Utiliza a imagem Docker do PostgreSQL.
Certifique-se de ter o Docker instalado e funcionando corretamente em seu sistema antes de seguir este tutorial.
Agora configure as variáveis de ambiente necessárias, como:
SECRET=ADWADAFAFKLASJGAOIKJGHSAIOGSJAIOGJA // a mesma validadora de JWT que será adicionada no frontend.
DATABASE_URL=postgresql://user:mypassword@localhost:5432/teste // connection string para estabelecer conexão com o banco de dados postgres.
Obs: Substitua user, mypassword e teste pelos valores que você configurou anteriormente.
Agora execute os seguintes comandos para configurar o banco de dados com as configurações necessárias:
$ npm run dev:migrate // para configurar o banco de dados.
$ npm run dev:populate // para popular o banco de dados.
Após ter instalado todas as dependências, você poderá executar do projeto sem gerar a build para o seu dispositivo com:
$ yarn dev
ou
$ npm run dev
Abra http://localhost:3333 com seu navegador para ver o resultado.
Configure as variáveis de ambiente necessárias, como:
NEXT_PUBLIC_API_URL=http://localhost:3333 // para se conectar com o backend.
SECRET=ADWADAFAFKLASJGAOIKJGHSAIOGSJAIOGJA // para os validadores do token JWT (utilize a mesma variável para o backend!).
Após ter instalado todas as dependências, você poderá gerar a build do projeto para o seu dispositivo com:
$ yarn dev
ou
$ npm run dev
Abra http://localhost:3000 com seu navegador para ver o resultado.
- Verifique as Issues que estão abertas e se já não existe alguma com a sua feature;
- Abra uma Issue com o nome e descrição da sua feature e assine com o seu usuário informando que irá fazê-la;
- Faça um fork do repositório;
- Entre no sua página do GitHub e faça um clone do seu fork;
- Crie uma branch com o nome da sua feature:
git chechout -b feat/minhaFeature
; - Faça as alterações necessárias no código ou na documentação;
- Instale as dependências do commitlint na raíz do projeto para a verificação dos commits:
npm install
ouyarn
; - Faça o commit das suas alterações seguindo as convenções de commit, adicione na descrição o id da sua Issue em parênteses e lembre de fechar a sua Issue com o id no rodapé do commit:
<tipo>(escopo opcional): <descrição> (#x)
[corpo do commit]
Close #x
Exemplo:
feat: adicionado componente para tal coisa (#52)
Foi adicionado um componente para tal coisa com o objetivo de melhorar tal coisa, deixando o projeto de tal maneira.
Close #52
- Faça um push para a sua branch:
git push origin feat/minhaFeature
; - Agora é só abrir um pull request no repositório que você fez o fork e assim que acontecer o merge sua Issue será fechada e suas alterações irão fazer parte do projeto;
- Depois que o merge da sua pull request for feito, você pode deletar a sua branch.
* Obrigado por contribuir! ❤️ 👊 😊