diff options
| -rw-r--r-- | README.md | 25 |
1 files changed, 23 insertions, 2 deletions
@@ -1,7 +1,7 @@ -# 4951w Pendulum +# Lamperski Inverted Pendulum - Web [](https://github.com/RosstheRoss/4951w-pendulum/actions/workflows/node.yml) -[](<https://snyk.io/test/github/RossTheRoss/4951w-pendulum>) +[](<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) + +``` |