boardfarm_server_vue's Introduction

Boardfarm Server based on Vue

A simple front-end web application for boardfarm.

Quick Start for developers

Install node for your machine https://nodejs.org/en/download/
```
# Ubuntu 18
sudo apt update
sudo apt install nodejs npm
```

Clone this project

git clone [email protected]:mbanders/boardfarm_server_vue.git

Install needed libraries
```
cd boardfarm_server_vue/
npm install
```

Let this app know where the backend is served from. Edit the file src/store/store.js:

loadStations ({ commit }) {
    axios
    .get('http://boardfarm.bluejam.net/api/stations')

Start server
```
npm run serve
```
Visit http://localhost:8080/ to see your website.

Serving for Production

This frontend web app is only static files, so it could be served by any webserver software you wish. Here we use Apache:

Install needed libraries

sudo apt update
sudo apt install apache2 nodejs npm

Install needed apache mods (this will allow serving both frontend and backend using a proxy)

sudo a2enmod proxy
sudo a2enmod proxy_http
sudo a2enmod proxy_balancer
sudo a2enmod lbmethod_byrequests

Clone this project & build static files to be served
```
git clone [email protected]:mbanders/boardfarm_server_vue.git
cd boardfarm_server_vue/
npm install
npm run build
```
The above creates a dist/ directory containing an index.html and other files.

Modify your apache site configuration file, default is /etc/apache2/sites-enabled/000-default.conf. The full path to the dist/ directory from above step is needed in two spots. And then add the two proxy lines are so that you can serve the boardfarm server backend being served by node:

<VirtualHost *:80>
    <Directory /path/to/boardfarm_server_vue/dist>
        Options FollowSymLinks
        AllowOverride None
        Require all granted
    </Directory>
    ...
    DocumentRoot /path/to/boardfarm_server_vue/dist
    ...
    
    # Reverse proxy to the backend REST api. This is optional, and you
    # probably run the REST api on a different port anyway.
    ProxyPass /api http://localhost:5001/api
</VirtualHost>

Restart apache
```
sudo service apache2 restart
```

You should now be able to visit http://localhost/ to see this frontend project, and also http://localhost/api/ to see the backend.

boardfarm_server_vue's People

Contributors

Stargazers

Watchers

boardfarm_server_vue's Issues

Switch from a v-for to v-show on the dashboard

This might be a more efficient way to draw the dashboard: https://stackoverflow.com/questions/43913454/vue-v-for-performance-is-poor

Polling the whole dataset is inneficient

The dashboard polls for data, asking for all the data every few seconds. Really it should just ask for all the data once, and then simply wait for new data on a websocket.

Specifically: The dashboard (src/views/Dashboard.vue), every few seconds, calls the function loadStations in the file src/store/store.js. Instead of doing this, it would be nice to only update when there's new data.