API Project Template (Back-end)

This repository serves as a template to kickstart new back-end API projects, configured with standardization tools to ensure code consistency and quality.

Standardization Tools

• ESLint: JavaScript/TypeScript linter.
• Prettier: Code formatter.
• Husky: Git hook execution tool.
• Lint-staged: Runs linters on staged files in Git.
• Conventional Commits: Commit message conventions.
• Commit Lint: Commit message linter.
• EditorConfig: Editor settings standardization.

How to Use This Template

1. Clone this repository to start a new project:

git clone https://github.com/joaohenriquefernandes/api-template.git <your_project_name>
cd <your_project_name>

2. Install project dependencies:

npm install

3. Start developing your API!

Additional Configurations

• EditorConfig: Configure editor rules in the .editorconfig file.
• ESLint: ESLint rules can be configured in the .eslintrc.js file.
• Prettier: Prettier settings can be defined in the .prettierrc file.
• Husky & lint-staged: Configure scripts in the package.json file.
• Conventional Commits: Utilize the specified conventions in commit messages.
• Commit Lint: Configure commit rules in the .commitlintrc file.

Contributing

Contributions are welcome! Feel free to open issues and send pull requests for improvements.

License

This project is licensed under the MIT License.