https://github.com/cinderblock/unifi-hotspot
Unifi Hotspot backend & UI
https://github.com/cinderblock/unifi-hotspot
Last synced: 2 months ago
JSON representation
Unifi Hotspot backend & UI
- Host: GitHub
- URL: https://github.com/cinderblock/unifi-hotspot
- Owner: cinderblock
- Created: 2019-08-12T19:12:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T06:59:59.000Z (over 3 years ago)
- Last Synced: 2025-06-05T10:50:12.476Z (about 1 year ago)
- Language: JavaScript
- Size: 2.64 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node Server UI base
Skeleton for a sever/client TypeScript pair.
## Details
This skeleton has 3 parts.
1. A super simple node.js daemon skeleton with socket.io and colorful logging facilities.
2. Basic React app skeleton with webpack, TypeScript, reactstrap, and socket.io client.
3. Deployment scripts
Many apps can just be run locally for testing or development or directly on a target machine which is useful if there special hardware attached.
## create-node-server-ui-app
Simple steps to make a new project/app based on this skeleton.
1. clone
1. Update `README.md` and `package.json`
1. `git commit -am 'Initial commit'`
## Development
The development environment is intended to be a first class and modern.
- Reload on save for client ui and server daemon running locally or remotely.
- Full color easy console logging.
- Easy debugging with source maps everywhere.
- Dependency changes automatically maintained with git hooks.
### Prerequisites
[**Node 10+**](https://nodejs.org/en/download) must be installed on your development system.
[**Yarn**](https://yarnpkg.com/lang/en/docs/install) is nice to have but **optional**.
### Setup
Install dependencies and setup development environment.
```bash
yarn setup
```
#### Non-global Yarn?
While easier if Yarn is installed globally, this works fine without it.
```bash
# Installs yarn locally
npm install
# Setup development environment
npm run setup
```
> You can run any command from the cheat sheet by replacing `yarn` with `npm run`.
### Running
To run this full system, **two** separate programs need to be run.
One for the web **UI** and one to actually do something persistent, the **daemon**.
### Remote Execution
In order to run the daemon on remote systems, the deploy config needs to be setup.
Copy or move `deploy/config.sample.ts` to `deploy/config.ts` and edit as desired.
Configs for daemons often need to be slightly different than when running locally.
The deploy script will replace `daemon/config.ts` with `daemon/config.remote.ts` on the remote system before execution.
### Suggested Environment
Use Visual Studio Code.
## Cheat sheet
All of these are run from the top level directory.
| Command | Description |
| ------------------------------ | ------------------------------------------------------------------------------------- |
| `yarn setup` | Setup your local machine for development |
| `yarn ui dev` | Run the web **ui** on your local machine (_dev mode_) |
| `yarn daemon dev` | Run **daemon** locally in watch mode with most recent local code |
| `yarn deploy daemon-dev` | Run local compiler in watch mode and **daemon** on remote with most recent local code |
| `yarn ui add some-package` | Add `some-package` to the ui |
| `yarn ui upgrade` | Upgrade ui packages to latest versions |
| `yarn upgrade-all` | Upgrade all packages to latest versions |
| `yarn remote add some-package` | Add `some-package` to the daemon using the remote's yarn |
| `yarn remote upgrade` | Upgrade daemon packages to latest version using the remote's yarn |
| `yarn remote kill` | Kill the daemon on remote |
| `yarn remote shutdown` | Shutdown the remote system |
| `yarn remote reboot` | Reboot the remote system |