Newschool Backend
Plataforma de ensino para pessoas carentes
Overview:
The NewSchool backend project, developed in NodeJS with a MySQL database, provides guidelines on how to run the project directly on your machine or through Docker, along with instructions on how to contribute to the project.
Features:
- NodeJS Backend: Developed using NodeJS technology.
- MySQL Database: Utilizes MySQL for data storage and management.
- Docker Support: Option to run the project via Docker for easy setup.
- Swagger Documentation: Access project API documentation via Swagger.
- E2E Testing: Includes scripts to execute end-to-end tests.
- Contribution Guidelines: Detailed steps on how to contribute to the project.
- Interactive Slack Channel: Join Slack community for discussions and task assignments.
- Task Management on Trello: Organize and track project tasks using Trello boards.
Summary:
The NewSchool backend project is a NodeJS application with a MySQL database, offering easy setup options either directly on the local machine or through Docker. The project includes features like Swagger documentation, E2E testing, and clear guidelines for contributions. By following the outlined steps, developers can efficiently set up, test, and contribute to the project, enhancing collaboration and project development.
- Nest
A progressive Node.js framework for building efficient, scalable, and enterprise-grade server-side applications with TypeScript/JavaScript.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.