Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2.28 KB

README.md

File metadata and controls

43 lines (28 loc) · 2.28 KB

Tedee Documentation

Overview

Tedee Documentation is the primary resource for exploring the platform's features, supported devices, and their detailed descriptions. Here, you will find comprehensive guides, step-by-step instructions, and in-depth explanations to help you understand and make the most of Tedee products and services.

Whether you're setting up a new device, troubleshooting, or diving into advanced functionalities, this documentation serves as your go-to reference.

Contribution

If you think that there are some areas that should be improved or extended please let us know by creating an issue with changes to specific documentation in subdirectories. However, we also highly encourage you to contribute to this repo, wheather you want to add some description, guide or provide a sample code.

Documentation specification

The documentation is:

Prerequisites

How to start

  1. Clone the Repository: First, clone the repository to your local machine using git clone https://github.com/tedee-com/tedee-documentation.git.

  2. Open Terminal: Navigate to the root directory of this repository using your terminal or command prompt.

  3. Install http-server:

    • Run npm install live-server -g to install a simple, zero-configuration command-line HTTP server.
    • This step requires Node.js and npm (Node Package Manager) to be installed on your machine.
  4. Start the Server:

    • Within the root directory of the repository, execute the command live-server.
    • This will start a local web server to serve the project files.
  5. Access the Application:

    • After running live-server, app will be available at http://localhost:8080.
    • Open this link in your web browser to view and interact with the project.

Next Steps

  • After successfully launching the project, you can start exploring the codebase.
  • Feel free to make modifications and test them in real-time using the local server.