Sobre o projeto · Tecnologias utilizadas · Primeiros passos · Padrões do projeto · To Do & Prazos · Licença
O projeto "SX", é uma solução completa para cadastro de empresas e seus colaboradores no Brasil, que traz funcionalidades para qualquer tipo de negócio prestador de serviços. Fácil de configurar e ainda mais fácil de usar para qualquer empreendedor!.
Para conseguir utilizar o projeto e contribuir nele, basta seguir as instruções abaixo:
- O Node.js é OBRIGATÓRIO para executar esse projeto e é RECOMENDADO usar a versão LTS.
- O NPM ou Yarn são OBRIGATÓRIO para o gerenciamento dos pacotes da aplicação.
- O Git é OBRIGATÓRIO para o controle de versão do projeto.
Primeiro clone o repositório em seu computador, por meio do terminal utilizando o comando:
- Clonando o repositório
# Clone o repositório
$ git clone https://github.com/juninho-dev/sx-challange.git
# Entre na pasta raiz da aplicação
$ cd sx-challange
- Configurando as variáveis de ambiente
- Rode o comando
openssl rand -base64 32
para gerar NEXT_AUTH_SECRET.
GITHUB_ID=YOUR_OAUTH_APP_ID
GITHUB_SECRET=YOUR_OAUTH_APP_SECRET
NEXTAUTH_SECRET=GENERATED_WITH
API_URL=http://localhost:3000
- Iniciando o Projeto
# Instale as dependências da aplicação
$ yarn # ou npm install
# Execute o generate do prisma
$ yarn prisma generate
# Execute o comando abaixo para iniciar o projeto
$ yarn dev
Para verificar o banco de dados, rode o comando abaixo
$ yarn prisma studio
- Orientação a objetos;
- SOLID
Feito com 💙 por 👾Juniel ® 2022.