README.md

LiMeApp

Geek-free Web App for setup and mantainance of Libremesh nodes built on Preact

Development Environment Installation

Clone this repo:

git clone https://github.com/libremesh/lime-app.git limeapp
cd limeapp

Install the dependencies:

npm install

# Or with docker
docker-compose run --rm ui npm i

Development Workflow

Start a live-reload development server

The LiMeApp is a frontend application for services running on a LibreMesh router. By running:

npm run dev

# Or with docker
docker-compose up

we can serve the LiMeApp with hot reloading and it will proxy every backend request to http://10.13.0.1, the default ip address for LibreMesh routers.

If you already have a LibreMesh router reachable at any given IP address, let's say 10.5.0.9, you can use it as a backend with:

env NODE_HOST=10.5.0.9 npm run dev

If you want, you can also setup a virtual LibreMesh node following lime-packages: TESTING.md, which will be available at http://10.13.0.1 by default.

Generate a production build

npm run build:production

Now you can copy the bundles to the router:

ssh [email protected] "rm -rf /www/app/*" && scp -r ./build/* [email protected]:/www/app

Run tests

npm run tests

Contribute

Plase, read the "How to contribute and code of conduct" documentation. We also have a Tutorial for newcomers :)