Coder Social home page Coder Social logo

heat's Introduction

Heat ๐Ÿ”ฅ

๐Ÿ”ฅ Create rooms for your events and monitor the crowd's excitement with Heat ๐Ÿ”ฅ
Practical project for study

Heat is released under the MIT license Heat is currently maintained by Silvio Ronaldo This is the number of forks in this repository This is the number of stars in this repository Badges are awesome

๐Ÿ“‹ Table of contents


๐Ÿค” How it works

Are you going to organize an event and want to stimulate the crowd's excitement? Just create a room in Heat!

Create a custom room for your event and make the code available to everyone and you're done.

With the code, anyone can enter the room and say what's waiting for your event.


๐Ÿ–ฅ๏ธ Demonstration

Web

Heat web


Heat web


๐Ÿ“† Upcoming features

New screens in mobile app to support new backend features


๐Ÿ•น๏ธ Running locally

Prerequisites

  1. Installing Git: You need to have Git on your machine to perform a few steps. To download Git, click here.

  2. Installing Node: To run the server you will need Node.js, to download it, click here.

  3. Installing Expo: To run the mobile, you need to install the Expo, click here.

  4. Installing Yarn 1: Yarn is a package manager that you can download directly from the website by clicking here. If you prefer, use the NPM.

  5. Code Editor (optional): Make sure you have a code editor of your choice. I recommend using the VS Code. If you need to, download it here.

๐ŸŽฒ Running the backend server

  1. In a terminal, clone this repository:

    git clone https://github.com/Silvio-Ronaldo/Heat.git

  2. Enter the project folder:

    cd Heat

  3. Enter the server folder:

    cd heat-api

  4. Install all dependencies:

    yarn install or yarn

  5. Start the SQLite database with all migrations using Prisma:

    yarn prisma migrate dev

  6. Start the development server:

    yarn dev

  7. After these steps, the server should start at the 3333 port.

โš›๏ธ Running the React app with Vite

  1. If you have already cloned the repository, open in another terminal window, otherwise, see first step in 'Running the backend server'.
  2. Enter the project folder:

    cd Heat

  3. Enter the web folder:

    cd heat-web

  4. Install all dependencies:

    yarn install or yarn

  5. Start the web development server:

    yarn dev

  6. After these steps, the server should start at the 3000 port, open the browser and access http://localhost:3000.

๐Ÿ“ฑ Running the Mobile app

  1. With the Expo installed, according to the documentation, follow. Otherwise, see first step in 'Running the backend server'.
  2. Enter the project folder:

    cd Heat

  3. Enter the mobile folder:

    cd heat-app

  4. Install all dependencies:

    yarn install or yarn

  5. Start the mobile development server:

    yarn start

  6. After these steps, the mobile application must start on your emulator or on your device, according to your choice.

๐Ÿ˜ผ Configuring OAuth App on Github

  1. To login with Github, you need to create an OAuth App. To do this, click on your user's avatar in the upper-right corner.
  2. Select Settings. Then, in the left menu click on Developer Settings.
  3. Click on OAuth Apps and create a new app.
  4. Enter the name and description you want.
  5. In Homepage URL, type: http://localhost:3333
  6. In Authorization Callback URL, type: http://localhost:3000/loading
  7. That's it, you've set up an OAuth App.

๐Ÿงท Connecting your OAuth App to Heat

  1. IMPORTANT: Go to the heat-web directory and within src/contexts/auth.tsx replace the constant value of GITHUB_CLIENT_ID with the Client ID value of your newly created OAuth App.
  2. IMPORTANT: Go to the heat-api directory and enter the .env.example file. Rename the file to .env
  3. IMPORTANT: Add your OAuth App's Client ID and Client Secret credentials to GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET, respectively.
  4. IMPORTANT: Go to a hash generator site like MD5 for example and generate a random hash. Add the hash to JWT_SECRET.

๐Ÿ›ก๏ธ Technologies

The main tools used in the development of the Heat:


๐Ÿ‘ฝ Author

Silvio Ronaldo
Silvio Ronaldo

๐Ÿ€

Leave your star, fork the project or open a pull request โค๏ธ

Contact me on social networks:

Silvio Ronaldo's Twitter Silvio Ronaldo's LinkedIn


โš–๏ธ License

Heat is MIT licensed, as found in the LICENSE file.

heat's People

Contributors

silvio-ronaldo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.