https://github.com/sunho/shower-server
lightweight code monitoring system for coding class
https://github.com/sunho/shower-server
education monitoring react rest-api
Last synced: 3 months ago
JSON representation
lightweight code monitoring system for coding class
- Host: GitHub
- URL: https://github.com/sunho/shower-server
- Owner: sunho
- License: mit
- Created: 2018-02-14T15:49:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-23T00:22:42.000Z (almost 8 years ago)
- Last Synced: 2025-01-26T15:28:12.612Z (over 1 year ago)
- Topics: education, monitoring, react, rest-api
- Language: TypeScript
- Homepage:
- Size: 186 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Introduction
🚿 A web simple code monitoring system.
# Brief explanantion
- **/*.go** is a back-end server. It supports recieving data from clients(atom pugin) and provides an api for administration.
- **public** directory includes an administration client made with typescript which supports monitoring clients connected to the server.
# Running the server
## Docker way
### Prerequisites
- docker
### Guide
Run the command below.
```
docker run -e USER=changeme -e PASS=changeme -p 5697:5697 ksunhokim/shower-server
```
Alternatively, you can build the image from Dockerfile.
```
git clone https://github.com/sunho/shower-server
cd shower-server
docker build -t shower-server . && docker run -e USER=changeme -e PASS=changeme -p 5697:5697 -it shower-server
```
Now open http://127.0.0.1:5697 in your favorite browser. You will see a tidy and shiny administration client.
## Standard way
### Prerequisites
- go compiler
- npm
### Guide
Run the command below.
```
go get github.com/sunho/shower-server
```
This will clone the repo and download every go dependency. Now you have to build the frontend or adiministration client.
```
cd $GOPATH/src/github.com/sunho/shower-server
npm install
npx webpack -p --config webpack.config.prod.js
```
After the build was completed, you should see dist folder full of html/js/css files. Now you can run the server.
```
export USER=changeme
export PASS=changeme
go build
./shower-server
```
The environment variables USER and PASS are going to be used as admin username and password for administarion client. Running the server in this way isn't really safe, because every process running on the host can access it. Thus if you're serious, you must use Docker or write a script so that the username and password wouldn't be exposed.
Now open http://127.0.0.1:5697 in your favorite browser. You will see a tidy and shiny administration client.
# Connecting to the server
Install Atom. And then, install "code-shower" package([guide](https://flight-manual.atom.io/using-atom/sections/atom-packages/)). Open edit\>Config... and replace "wss://sunho.kim/shower" with "ws://127.0.0.1:5697" Finally, open packages\>Code Shower\>reload. Now if you edit some arbitrary file, it will be shown in the administarion client.