Project built during the React Immersion Alurakut edition of Alura!.
- Technologies
- Installation
- Getting Started
- Found a bug? Missing a specific feature?
- Contributing
- License
This project was developed with the following technologies:
You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:
git clone https://github.com/monteiro-alexandre/alurakut.git
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:
git clone git@github.com:monteiro-alexandre/alurakut.git
Install dependencies
yarn install
Or
npm install
Create your environment variables based on the examples of .env.development
cp .env.development .env.local
After copying the examples, make sure to fill the variables with new values.
| key | description | example |
|---|---|---|
| JWT_SECRET | Secret key to generate the JWT token | any_jwt_secret_key_string |
Run the following command in order to start the application in a development environment:
yarn dev
Feel free to file a new issue with a respective title and description on the the Alurakut 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.
Check out the contributing page to see the best places to file issues, start discussions and begin contributing.
This project is licensed under the MIT License - see the LICENSE file for details.