The NikkeTeams project consists of a Restful API still in development for sharing teams among Nikke game players, in order to efficiently help them progress more easily. The API was built following the principles of clean architecture along with best software development practices such as TDD (Test Driven Development), SOLID, and design patterns.
The chosen technologies were selected based on their efficiency and suitability for the project, including Node.js with Typescript as the main language, Fastify as the web application framework, Jest as the unit testing framework, Prisma as the ORM for accessing the Postgres database, Redis as the in-memory database for caching and performance optimization, AWS S3 as the cloud file storage service, and Docker to facilitate the deployment and scalability process of the application.
I developed all the code with a focus on ensuring the maintainability, scalability, and robustness of the application.
git clone git@github.com:yorigcs/NikkeTeamsAPI.git && cd NikkeTeamsAPInpm install-unit
npm run test-integration
npm run test:integration-coverage
npm run test:coveragenpm run prisma:migrate:devnpm run devDon't forget to config .env and .env.test the same as the .env.example
- @aws-sdk/client-s3: AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native.
- @prisma/client: auto-generated query builder that enables type-safe.
- bcrypt: A library to help you hash passwords.
- dotenv-cli: manage multiple envs.
- module-alias: Create aliases of directories and register custom module paths in NodeJS.
- uuid: For the creation of RFC4122 UUIDs.
- rimraf: The UNIX command rm -rf for node.
- jsonwebtoken: An implementation of JSON Web Tokens.
- fastify: Faster web framework for nodejs.
- @fastify/cookie: A plugin for Fastify that adds support for reading and setting cookies.
- @fastify/cors: A plugin for Fastify that enables the use of CORS.
- @fastify/multipart: Fastify plugin to parse the multipart content-type.
- @fastify/rate-limit: An implementation of JSON Web Tokens.
- dotenv: Dotenv is a zero-dependency module that loads environment variables from a .env.
- eslint-config-standard-with-typescript: An ESLint shareable config for TypeScript that is based on eslint-config-standard.
- husky: Modern native Git hooks made easy.
- lint-staged: Run linters against staged git files.
- jest: Delightful JavaScript Testing.
- jest-mock-extended: Type safe mocking extensions for Jest.
- prisma: Prisma is a next-generation ORM.
- supertest: HTTP assertions made easy via superagent. Maintained for Forward Email and Lad.
- ts-jest: A Jest transformer with source map support that lets you use Jest to test projects written in TypeScript.
- ts-node-dev: Tweaked version of node-dev that uses ts-node under the hood.
- typescript: Language for application-scale JavaScript.
- @types/bcrypt: TypeScript definitions for bcrypt.
- @types/jest: TypeScript definitions for jest.
- @types/supertest: TypeScript definitions for supertest.
- @types/uuid: TypeScript definitions for uuid.
- @types/module-alias: TypeScript definitions for module-alias.
- @types/jsonwebtoken: TypeScript definitions for jsonwebtoken.
MIT