Tips for Front‐End developers

How to set up the front-end development environment

Zoraxy is built with a pretty simple logic. By default, the web resources are built into the zoraxy binary itself. However, when the -dev flag is set to true (i.e. ./zoraxy -dev=true), the web directory will be loaded from the ./web folder instead.

So if you are working on some new front-end features of Zoraxy, you can use the following recommended flow to setup your development environment

1. Fork Zoraxy to your own github account
2. Git clone your Zoraxy (git clone https://github.com/foobar/zoraxy)
3. cd into the src file (cd ./zoraxy/src/)
4. build the project (go build)
5. Start zoraxy with the dev flag (./zoraxy -dev=true)

Next, you can use your preferred IDE to open the ./web/ folder and start making your changes.

How to run or hot-reload the frontend during development

When Zoraxy is running in dev mode, you can modify any html files in the ./web/ folder. Once the changes are made and saved, go to your browser and visit the admin panel (default to http://locahost:8000), navigate to the page that you just modified and you will see the changes shown on your browser.

Sometime changes might not show immediately, try to clear your browser cache or open the development tools (some browsers will only clear cache and refresh with this tool open).

Where are the APIs defined?

The API of Zoraxy are all defined in the api.go file under the src folder. See more in the source file.