Getting Started
1. Install Docker Desktop
All we need to run Flare Hotspot development runtime is Docker. You can download it from here.
For a detailed instruction to install Docker Desktop, please refer to the official documentation or follow our beginner-friendly tutorial for windows.
Note
For Linux/Mac users, you can install Docker using the package manager of your distribution.
2. Download Flare Hotspot SDK
Download the latest devkit-x.x.xzip file from https://github.com/flarehotspot/sdk/releases repository. Select the appropriate zip file that's compatible with your CPU architecture. Windows computers are most likely be running Intel or AMD x86 CPUs, so just select devkit-0.0.13-pre-amd64.zip (whatever is the latest release file).
After downloading, extract the zip file to your desired location.
3. Start The SDK Runtime
To start the SDK runtime, open windows CMD or PowerShell and navigate to the extracted file's root directory then run:
For VSCode users, you can also do this in the terminal.
Docker may take sometime to download and install the container and its dependencies. Wait for the message Listening on port :3000 which indicates that the server is already running and ready to accept connections.
Now you can access the Flare Hotspot web interface:
- Captive Portal: http://localhost:3000
- Admin Dashboard: http://localhost:3000/admin
- Database Management: http://localhost:8080
To restart the server and recompile the code, open a new terminal then run:
4. Upgrading The SDK
To upgrade the SDK, download the latest release from the SDK releases page and extract the contents to your desired destination. Then copy your plugin directory into the plugins directory inside the new SDK. Make sure to stop the previous SDK runtime then start the new SDK runtime.