Nest auth with Token JWT
Portuguese: O projeto é uma aplicação de autenticação desenvolvida utilizando NestJS, que utiliza tokens JWT para autenticação de usuários. A aplicação inclui funcionalidades de criação de usuários, consulta de usuários por diversos critérios (ID, email, nome), e autenticação de usuários através de um endpoint de login. Foi implementado utilizando as melhores práticas de segurança e boas práticas de Typescript, além de integração com Prisma para manipulação do banco de dados SQLite. A documentação da API está disponível através do Swagger.
English: The project is an authentication application developed using NestJS, which utilizes JWT tokens for user authentication. The application includes functionalities for user creation, user retrieval based on various criteria (ID, email, name), and user authentication through a login endpoint. It has been implemented using best security practices and Typescript best practices, along with integration with Prisma for SQLite database manipulation. API documentation is available through Swagger.
Portuguese: Para instalar o projeto localmente, siga os seguintes passos:
Clone o repositório do projeto. Navegue até o diretório do projeto e execute npm install para instalar as dependências. Configure as variáveis de ambiente necessárias conforme descrito na seção de configuração.
English: To install the project locally, follow these steps:
Clone the project repository. Navigate to the project directory and run npm install to install dependencies. Configure necessary environment variables as described in the configuration section.
Portuguese: Antes de executar o projeto, é necessário configurar algumas variáveis de ambiente. No arquivo .env, defina as variáveis de ambiente necessárias, como informações de conexão com o banco de dados, segredo JWT, etc.
English: Before running the project, some environment variables need to be configured. In the .env file, set up the required environment variables such as database connection information, JWT secret, etc.
Portuguese: Para usar o projeto, siga os seguintes passos:
Execute npm start para iniciar o servidor. Acesse a documentação da API disponível em /api para obter detalhes sobre os endpoints disponíveis e como usá-los. Utilize ferramentas como Postman ou Insomnia para interagir com os endpoints e testar as funcionalidades da aplicação.
English: To use the project, follow these steps:
Run npm start to start the server. Access the API documentation available at /api for details on available endpoints and how to use them. Utilize tools such as Postman or Insomnia to interact with the endpoints and test the application's functionalities.
Portuguese: A documentação completa da API está disponível através do Swagger. Acesse a rota /api após iniciar o servidor para visualizar e interagir com a documentação.
English: Comprehensive API documentation is available through Swagger. Access the /api route after starting the server to view and interact with the documentation.
Portuguese: Se você deseja contribuir para o projeto, siga estas etapas:
Faça um fork do repositório. Implemente as alterações desejadas em uma nova branch. Abra um pull request descrevendo as alterações propostas.
English: If you wish to contribute to the project, follow these steps:
Fork the repository. Implement desired changes on a new branch. Open a pull request describing the proposed changes.
Portuguese: Este projeto está licenciado sob a MIT licensed. Consulte o arquivo LICENSE para obter mais detalhes.
English: This project is licensed under the MIT licensed. See the LICENSE file for more details.