Connect Lab

Connect Lab is a IoT management system that allows users to create accounts, check the weather forecast for their surroundings, edit their profiles, browse available devices, link devices to their account, and turn devices on/off. Made as part of SENAI's DEVinHouse course.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Connect Lab is a IoT management system that allows users to create accounts, check the weather forecast for their surroundings, edit their profiles, browse available devices, link devices to their account, and turn devices on/off. Made as part of SENAI's DEVinHouse course.

(back to top)

Built With

  • React
  • Vite
  • React Query
  • styled-components

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

  1. Get a free API Key at https://openweathermap.org/api

  2. Clone the repo

    git clone https://github.com/francisko-rezende/connect-lab.git
  3. Install NPM packages

    npm install
    
    // or
    
    yarn
  4. Enter your API in .env.local

    VITE_OPENWEATHER_KEY=ENTER_YOUR_API
  5. You also need to add the backend's base url in .env.local:

    VITE_API_BASE_URL=ENTER_URL

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Francisko de Moraes Rezende - @francisko_r - Project Link: https://github.com/francisko-rezende/connect-lab

(back to top)

(back to top)