rushilwiz/robot-gui
1
0
Fork 0
mirror of https://github.com/PotentiaRobotics/robot-gui.git synced 2025-04-20 19:00:16 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated outdated readme :P

Browse Source
This commit is contained in:
Vrishak Vemuri 2022-11-17 21:34:51 -05:00 committed by GitHub
parent 01bf537113
commit 8644a6f085
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -5,17 +5,11 @@ The web server is meant to run on a flask backend, but we currently just run it
### Code Description ### Code Description
`bare/` Files containing the actual vanilla server, with vanilla HTML and CSS code. As of now, the code **is** integrated with the flask server, which is able to send commands to the RaspberryPi via python's socket library.
- `bare/index.html` is the main HTML file of the server. - `static/` contains CSS files integrated into the flask application for styling purposes.
- `bare/style.css` is the main CSS file of the server. Currently is just vanilla without tailwind framework. - `templates/` contains the HTML pages we display in our gui.
- All other files are images used in the server. - `app.py` is the flask application to be run. This features both intialization of pages and can send/recieve commands
All of our other files are related to the flask backend, but do not contain any meaningful server code:
- `static/` contains placeholder CSS files to be integrated into the flask application.
- `templates/` contains placeholder HTML filess to be integrated into the flask application.
- `app.py` is the flask application to be run. If backend were integrated the command to initiate the server is `python app.py`.
- `tailwind.config.js` configures tailwind. - `tailwind.config.js` configures tailwind.
### Setup and Run. ### Setup and Run.
@ -26,10 +20,16 @@ All of our other files are related to the flask backend, but do not contain any
git clone https://github.com/PotentiaRobotics/robot-gui.git git clone https://github.com/PotentiaRobotics/robot-gui.git
``` ```
2. `cd` to `bare/` directory 2. Install required libraries (`requirements.txt` to be generated, for now just install what is required in `app.py`)
3. Set up RaspberryPi server code (to be uploaded to this repo) and allow port 2345 and 2346
4. Run server code on the RaspberryPi
``` ```
cd bare/ python server1.py
``` ```
3. Run live server on `index.html` or open `index.html` with web browser 5. Initialize client
```
python app.py
```