Eduardo-H/nlw-heat-web

A web page for a project built during the Next Level Week event.

NLW Heat Web

About

This project was build during the Next Level Week event, its main goal is to gather people to talk about their expectations for a future event, called DoWhile. After watching all classes, I decided to implement a private chat.

Techonologies

• React
• Vite
• Framer Motion (animations)
• Sass

Dependencies

Since this project connects with Github, you'll need to create a oAuth app on your GitHub. You can follow this tutorial to create the oAuth app. After creating it, you need to add the environment variables on the .env file.

.env example

# GitHub
VITE_GITHUB_CLIENT_ID=YOUR_GITHUB_CLIENT_ID

# Sign In
VITE_SIGN_IN_URL=https://github.com/login/oauth/authorize?scope=user&client_id=YOUR_GITHUB_CLIENT_ID

Note: The project will only work correctly if the back-end project is running already, you can find the repository here.

Usage

To run the project, you can follow these steps:

• Clone the repository with git clone https://github.com/Eduardo-H/nlw-heat-web
• Navigate into the project's folder cd nlw-heat-web/
• Install all the project's dependencies by running yarn
• Run the project with yarn dev