diff options
author | Matt Strapp <matt@mattstrapp.net> | 2022-02-18 11:55:03 -0600 |
---|---|---|
committer | Matt Strapp <matt@mattstrapp.net> | 2022-02-18 11:55:03 -0600 |
commit | ce5c8fffad6827b77259faef464de0c77885af52 (patch) | |
tree | 7d1a2126b7bfb3fc5b7587b149250ca0d11a2392 | |
parent | Make output package file consistent (diff) | |
download | ee4511w-web-ce5c8fffad6827b77259faef464de0c77885af52.tar ee4511w-web-ce5c8fffad6827b77259faef464de0c77885af52.tar.gz ee4511w-web-ce5c8fffad6827b77259faef464de0c77885af52.tar.bz2 ee4511w-web-ce5c8fffad6827b77259faef464de0c77885af52.tar.lz ee4511w-web-ce5c8fffad6827b77259faef464de0c77885af52.tar.xz ee4511w-web-ce5c8fffad6827b77259faef464de0c77885af52.tar.zst ee4511w-web-ce5c8fffad6827b77259faef464de0c77885af52.zip |
Change git to the new repos
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
-rw-r--r-- | README.md | 25 |
1 files changed, 23 insertions, 2 deletions
@@ -1,7 +1,7 @@ -# 4951w Pendulum +# Lamperski Inverted Pendulum - Web [![GitHub Actions](https://github.com/RosstheRoss/4951w-pendulum/actions/workflows/node.yml/badge.svg)](https://github.com/RosstheRoss/4951w-pendulum/actions/workflows/node.yml) -[![Known Vulnerabilities](<https://snyk.io/test/github/RossTheRoss/4951w-pendulum/badge.svg>)](<https://snyk.io/test/github/RossTheRoss/4951w-pendulum>) +[![Known Vulnerabilities](<https://snyk.io/test/github/UMN-EE4951W-Lamperski/pendulum-web/badge.svg>)](<https://snyk.io/test/github/UMN-EE4951W-Lamperski/pendulum-web>) An complete rewrite of the web application for Professor Andrew Lamperski's Remotely Accessible Inverted Pendulum, in TypeScript. @@ -12,3 +12,24 @@ An complete rewrite of the web application for Professor Andrew Lamperski's Remo - Login with the University's Shibboleth system. - Add the livestreaming feature. - **Improve the readme.** + +## Structure + +The structure of the repository is as follows: +``` +├── src (folder) +│ ├── public (folder) +│ │ ├── css (where all CSS files are stored) +│ │ │ └── style.css (the main CSS file) +│ | ├── js (where all on-site JavaScript files are stored) +│ | │ └── form.js (JavaScript for the form's AJAX requests) +│ | └── img (Images for the website) +| | └── site-logo.png (the logo for the website, used as a favicon and in the about page) +│ ├── routes (folder) +│ | └── api.ts (the API endpoints) +│ ├── views (folder) +│ │ ├── pages (Template files for the main static pages) +│ │ └── partials (Boilerplate used by every static page) +| └── index.ts (the entry point, where the static content is served) + +``` |