Description

Craft a tailored suite of validators and sanitizers by extending the functionality of express-validator to precisely align with the unique needs of the project.

Acceptance Criteria

• Create a custom validator with the requirements of the project
• Create a custom sanitiser with the requirements of the project

Description

Look into implementing multiple environment configuration

Acceptance Criteria

• Establishing distinct environment configurations, such as local and production settings.
• Considering the use of json-server for local environment testing as an alternative to a MongoDB Atlas instance.

Description

Research into ways to improve error handling and implement them across the project

Acceptance Criteria

• Standardise error handling on middleware handlers
• Standardise error handling on validator handlers
• Standardise error handling on controller / service levels
• Standardise error handling on server initialisation and unexpected failures

Description

Explore the implementation of Swagger or any other alternative documentation standards to provide comprehensive and user-friendly documentation for the project's APIs

Acceptance Criteria

• Integrate API documentation

Description

Delve deeper into industry best practices for creating highly maintainable code, with a particular emphasis on optimizing the structure of middleware, services, and controllers.

Acceptance Criteria

• Research into idiomatic NodeJS project structure for simple API projects
• Create a fully compliant backend API project structure

Description

Incorporate pre-commit hooks and GitHub workflows to automate essential tasks:

Acceptance Criteria

• Configuring the project with tools like husky and lint-staged for enforcing linting and code formatting checks.
• Implementing GitHub workflows to perform linting, code formatting, and test execution upon the creation of pull
  requests.

Description

Implement comprehensive tests using either the Mocha, Chai, and Supertest stack or exploring the use of Playwright.

Acceptance Criteria

• Create runnable unit and functional tests on local environment
• Utilise industry standards tooling for code coverage

Description

Look into the creation of MongoDB seeders for dev and test environment to facilitate local spinning up of databases

Description

As part of freeCodeCamps' Back End Development and APIs certification, it has to be run on a browser. This has resulted in creating a Babel transpiler that will convert the code to CommonJS. After I pass the certification, I would like to remove these along with Nodemon to keep the project configuration and dependency structure simple.

Acceptance Criteria

• Deprecate Babel
• Deprecate Nodemon
• Deprecate rimraf
• Update to type="module" in package.json
• Update npm run dev and npm run start scripts in package.json
• Update imports across whole project

Description

Enhancing the logging mechanism used in the project to align with industry-standard logging practices for better traceability and debugging.

Acceptance Criteria

• Research into industry best practises for logging
• Implement standardised logging across project especially on error handling