API - FrontEnd (NLW - Heat)
Technology | Layout | Documentation | Note
🚀 Technology
This project was developed with the following technologies
💻 Layout
The following are images of the project and their descriptions
Documentation
To use this application on your machine you must first check if you have the following technologies and their versions:
Node version 13+
Vite
Well, come on, do a clone of this repository. Then, navigate to the folder where it was cloned (or if you have a code editor with integrated terminal, just open it) and type:
npm start
or
yarn
After that, just give the command: yarn dev or npm run dev
Notes:
- If you use yarn, make sure you have yarn installed
- If you want to mirror it and one day take it into production, remember to build the application and run the script pointing to /dist
This application uses github authentication, so it will be necessary to configure your github oauth along with the application.
Don't forget to create an .env file and declare your variables there.
Note
- Application subject to future improvements and implementations
- Application was done at the Rocketseat event, changing knowledge, and architectures on my
- It is necessary to run a rest application (backend) in the background. you can download it here , feel free (Make sure you align the environment and data variable contexts)