- First, a cup of coffee ☕;
- Node JS installed on your host;
- The ✳️ Required API running.
In order to clone the project (via HTTPS), run this command:
git clone https://github.com/MattZ6/required.git
💡 SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:
git clone [email protected]:MattZ6/required.git
Go to project folder:
cd required
Install the project dependencies:
pnpm i
The project has some environment variables so that we can have dynamic settings based on the context in which it is running.
First, create a copy of .env.example
:
cp .env.example .env.local
Then fill in the missing values in the variables.
To run the development server:
pnpm dev
Contributions, issues and new features are always welcome! You can explore them here.
Feel free to submit a new issue with a respective title and description on the the Required repository. If you already found a solution to your problem, i would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.
Released in 2022 © This project is under MIT License.
Made with ❤ by Matheus Felipe Zanin.
Get it touch!