JavaScript project boilerplate
Meilisearch | Documentation | Discord | Website | FAQ
A boilerplate to start a JavaScript project
The boilerplate provides the base needs we require from every JavaScript project
To start your project, clone this repository and remove git from it. After which, you can create a new GitHub project that starts with this base.
Table of Contents
✨ Linter
JavaScript project follow linting and format rules.
The linting rules are applied by eslint, we follow their recommended rules.
The formatting is provided by prettier.
To check if your code is well linted, you can use the following command:
yarn lint
To fix and format your code, you can use the following command:
yarn lint:fix
🔧 Github Actions
In the .github the following GitHub actions are present:
- Templates suggesting formatting of issues in the repository (
ISSUE_TEMPLATE) - A release drafter that will automatically update your GitHub release body with the merged PR's.
- Tests that will run on each PR. It only tests the linting in this project, but you should add more jobs.
- A
dependabotconfiguration to determine when and howdependabotsuggests package updates. The configuration should not change unless it was decided.
🙈 gitignore
The .gitignore ignores the most frequent directories and file naming that should not be pushed to GitHub. It should be updated accordingly to your needs.
📄 License
The licensing file contains the license Meilisearch used across our projects. The years should be updated accordingly to the current year.
🖇 Bors
A testing and merging tool used to merge PR's. Please refer to this documentation.
🎳 Editor Config
An .editorconfig file that follows some style rules used accros all JavaScript projects.
⚠️ Project Settings
What this boilerplate does not provide are the repositories settings that should be manually configurated:
- Project access management.
- Enable dependabot security alerts, updates and graph.
- Main branch protection.
- Add project in bors.