https://github.com/aikid/knights-backend
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (3.4%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: aikid
- Language: TypeScript
- Default Branch: master
- Size: 128 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Knights Backend
Seja bem vindo jovem cavaleiro! Knights Backend é uma API desenvolvida com NestJS e Prisma que serve como um sistema de gerenciamento de cavaleiros. Utilizando o banco de dados MongoDB, esta aplicação fornece um conjunto de endpoints para criar, listar e gerenciar cavaleiros e suas informações, além poder também promover um cavaleiro. A documentação da API é fornecida pelo Swagger.
Sumário
Tecnologias
- Node
- NestJS
- Prisma
- MongoDB
- Swagger
- Vitest
Instalação
- Clone o repositório:
bash
git clone https://github.com/aikid/knights-backend.git
cd knights-backend
- Instale as dependências:
Certifique-se de ter o Node.js e o npm instalados. Em seguida, execute:
bash
npm install
Configuração
- Variáveis de ambiente:
Crie um arquivo .env na raiz do projeto e adicione as seguintes variáveis de ambiente:
env
DATABASE_URL="mongodb+srv://knights:knights2025BTG@cluster0.x6lnxin.mongodb.net/kingdom?retryWrites=true&w=majority"
PORT=3333
Substitua o valor de DATABASE_URL pela URL de conexão do seu banco de dados MongoDB.
- Configuração do Prisma:
Após configurar as variáveis de ambiente, gere o cliente Prisma:
bash
npx prisma generate
Execução
- Ambiente de Desenvolvimento:
Para iniciar a aplicação em modo de desenvolvimento:
bash
npm run start:dev
A API estará disponível em:
http://localhost:3333.
Testes
Para executar os testes, utilize:
bash
npm run test
Para testes de integração:
bash
npm run test:e2e
Para verificar a cobertura dos testes:
bash
npm run test:cov
Os testes E2E são executados em um banco separado, já configurado no arquivo setup-e2e.ts dentro da pasta src/test
Documentação da API
A documentação da API, gerada pelo Swagger, estará disponível em:
bash
http://localhost:3333/api
Contribuição
Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests.
Suporte
- Autor: Leandro Brito do Nascimento Nogueira
- Linkedin: https://www.linkedin.com/in/leandro-brito-do-nascimento-5b9319105/
- Github: https://github.com/aikid
Owner
- Name: Leandro Brito do Nascimento
- Login: aikid
- Kind: user
- Location: Brazil
- Company: Aikid Developer
- Repositories: 2
- Profile: https://github.com/aikid
Programador by the knowledge, every day a new teaching grace to God.
GitHub Events
Total
- Push event: 3
- Create event: 2
Last Year
- Push event: 3
- Create event: 2
Dependencies
- 853 dependencies
- @nestjs/cli ^11.0.0 development
- @nestjs/schematics ^11.0.0 development
- @nestjs/testing ^11.0.1 development
- @rocketseat/eslint-config ^2.2.2 development
- @swc/cli ^0.6.0 development
- @swc/core ^1.10.11 development
- @types/express ^5.0.0 development
- @types/node ^22.10.7 development
- @types/supertest ^6.0.2 development
- @vitest/coverage-v8 ^3.0.4 development
- dotenv ^16.4.7 development
- eslint ^8.57.1 development
- globals ^15.14.0 development
- prisma ^6.2.1 development
- source-map-support ^0.5.21 development
- supertest ^7.0.0 development
- ts-node ^10.9.2 development
- tsconfig-paths ^4.2.0 development
- typescript ^5.7.3 development
- typescript-eslint ^8.20.0 development
- unplugin-swc ^1.5.1 development
- vite-tsconfig-paths ^5.1.4 development
- vitest ^3.0.4 development
- @nestjs/common ^11.0.1
- @nestjs/config ^4.0.0
- @nestjs/core ^11.0.1
- @nestjs/platform-express ^11.0.1
- @nestjs/swagger ^11.0.3
- @prisma/client ^6.2.1
- reflect-metadata ^0.2.2
- rxjs ^7.8.1
- swagger-ui-express ^5.0.1
- zod ^3.24.1
- zod-validation-error ^3.4.0