⚠️ This is a template for the README.md file. Please edit it accordingly to your project.
⚠️ Also, on the repositoryAbout ⚙️
section (on the right side of the page 👉)
- Add a good
Description
;- Add a set of
Topics
that describe the project;
Choose a self-explaining name for your project.
List the prerequisites for running the project locally.
List the environment variables that are required to run the project locally.
We strongly recommend using VSCode with the following extensions:
- licenser for adding license headers.
- editorconfig for enforcing consistent coding styles between different editors and IDEs.
Open the project in VSCode, open the command palette (Ctrl+Shift+P) and search for Preferences: Open Workspace Settings (JSON)
.
Paste the following configuration:
{
"licenser.license": "Custom",
"licenser.author": "Explore.dev, Unipessoal Lda",
"licenser.customHeader": "Copyright (C) @YEAR@ @AUTHOR@ - All Rights Reserved\nUse of this source code is governed by a license that can be\nfound in the LICENSE file."
}
Explain how to debug the project using VSCode.
Explain how to deploy the project to stage.
Explain how to deploy the project to production.
This project is available under the GNU Lesser General Public License v3.0 license.