clone-tabnews

Implementação do projeto do https://curso.dev

Status

Start Here

How to Commit

In this repository, we use the Conventional Commits approach. To avoid any issues when committing code from your machine to this repository, it is highly recommended that you run the following command:

npm run commit

This will invoke the cz library, which will guide you through creating a commit that follows the Conventional Commits approach.

Running the Project

If this is your first time interacting with a Node project, there are a few things you need to do before getting the project up and running. First, install node and nvm -- both are important to have on your machine.

Once you have installed both, it is time to tell Node to use the correct version to run this application. To do that, navigate to the same directory level where you created the .nvmrc file. Once you are in the correct location, run the following command:

nvm use

This will tell nvm to use the content of the .nvmrc file to download and set the Node version specified by the .nvmrc file.

After that, you can run the following command:

nvm alias default $(cat .nvmrc)

This command instructs nvm to set the default version to the one defined in the .nvmrc file.

We can move on to installing all the necessary dependencies for the project. You can do this by executing the following command:

npm install

After this command is executed and all the dependencies are installed, it is time to use the dev script to get the project up and running. To see what this script will do, go to package.json and look under the scripts section for the key dev.

To run this script, use the following command:

npm run dev

Adjusting Your Editor

All the configurations mentioned here were performed using vscode as the editor.

First of all, make sure to install editor plugins capable of interacting with the .editorconfig and .prettierignore files. If you are using vscode, you can search for editorconfig and prettier.

After installing those plugins, configure your editor by going to the Settings page and following these steps:

• Search for formatter and set the default formatter to Prettier.
• Search for format on save and enable the option to format the file on save.
• Search for auto save and turn this option off.

Environment variables

We use the environment variables approach to avoid hard-coded values for security reasons. The file containing variables for your production environment should NEVER be committed as part of the codebase.

For development, we are using a file called .env.development, located at the same level as the .nvmrc file. There, you will find all the necessary environment variables for running the application locally.

Working with NVM

Setting .nvmrc file content

To follow some best practices on node projects, we will use NVM. One of the required things in the project is to have on the root of your project folder a file called .nvmrc which should contain the node version that better suits the project. This will allow other developers who use nvm to run your project in the correct version. We can set the content of this file by using the following command:

node -v > .nvmrc

Setting project engines

Another best practice is to set the engines that your project requires, like the .nvmrc file approach this one will indicate node which engine your project uses and this will taken into consideration when installing libs to the project. We can set that information after the project creation by running the following command:

npm pkg set engines.node=$(node -v)