💬 Letmeask is an application for help the people with the questions while in streams live in Youtube, Twitch, or any other platform.
Developed at NLW#6
Practical project for study

📋 Table of contents

• Status
• Demonstration
• Extra Features
• Running Locally
• Firebase
• Technologies
• Author
• License

📌 Status

🚧 Letmeask is active. 🚀

🖥️ Demonstration

To access and test the Letmeask platform, click on the link: https://letmeask-daa0e.web.app

Enter an existing room

Sign in and Create your own room

Clear your doubts and follow up on others' doubts

🔐 For admin! 🔐 Manage the room, highlight questions and remove questions at any time.

🔥 Extra Features

Dark Mode

Responsive

Modal

PWA

🆕 New extra features are in development... ⚒️

🕹️ 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 Yarn 1: Yarn is a package manager that you can download directly from the website by clicking here. If you prefer, use the NPM.


3. 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 React App

1. In a terminal, clone this repository:

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

2. Enter the project folder:

   cd Letmeask

3. Install all dependencies:

   yarn install or yarn

4. Start the development server:

   yarn start

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

Running Letmeask PWA

To install PWA, access the Letmeask platform through Chrome or Edge browsers, both on your smartphone and on your computer and click on install application.

🟠 Firebase

Attention: Letmeask uses the Realtime database provided by Firebase. So, if you download the code and run it on localhost and if you want the application to work correctly on your machine locally, create an account in Firebase, and configure the Realtime database according to the rules present in the file database.rules.json. After that, get your app credentials from the Firebase console and put it in the .env according to the .env.example!

🛡️ Technologies

The following tools were used in the development of the project:

• React
• Firebase
• Realtime database
• TypeScript
• Styled Components
• Unform
• Eslint
• Prettier
• React Modal
• React Icons

👽 Author

Silvio Ronaldo 🍀

Leave your star, fork the project or open a pull request ❤️

Contact me on social networks:

⚖️ License

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