Add docusaurus documentation

- This is really just a test to see if everything goes as planned.
SafeStepCSU · Apr 12, 2024 · f94f938 · f94f938
1 parent 7038999
commit f94f938
Show file tree

Hide file tree

Showing 49 changed files with 16,202 additions and 0 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/docs/babel.config.js b/docs/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/blog/2019-05-28-first-blog-post.md b/docs/blog/2019-05-28-first-blog-post.md
@@ -0,0 +1,12 @@
+---
+slug: first-blog-post
+title: First Blog Post
+authors:
+  name: Gao Wei
+  title: Docusaurus Core Team
+  url: https://github.com/wgao19
+  image_url: https://github.com/wgao19.png
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/docs/blog/2019-05-29-long-blog-post.md b/docs/blog/2019-05-29-long-blog-post.md
@@ -0,0 +1,44 @@
+---
+slug: long-blog-post
+title: Long Blog Post
+authors: endi
+tags: [hello, docusaurus]
+---
+
+This is the summary of a very long blog post,
+
+Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
+
+<!--truncate-->
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/docs/blog/2021-08-01-mdx-blog-post.mdx b/docs/blog/2021-08-01-mdx-blog-post.mdx
@@ -0,0 +1,20 @@
+---
+slug: mdx-blog-post
+title: MDX Blog Post
+authors: [slorber]
+tags: [docusaurus]
+---
+
+Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
+
+:::tip
+
+Use the power of React to create interactive blog posts.
+
+```js
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+```
+
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+
+:::
diff --git a/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/docs/blog/2021-08-26-welcome/index.md b/docs/blog/2021-08-26-welcome/index.md
@@ -0,0 +1,25 @@
+---
+slug: welcome
+title: Welcome
+authors: [slorber, yangshun]
+tags: [facebook, hello, docusaurus]
+---
+
+[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
+
+Simply add Markdown files (or folders) to the `blog` directory.
+
+Regular blog authors can be added to `authors.yml`.
+
+The blog post date can be extracted from filenames, such as:
+
+- `2019-05-30-welcome.md`
+- `2019-05-30-welcome/index.md`
+
+A blog post folder can be convenient to co-locate blog post images:
+
+![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
+
+The blog supports tags as well!
+
+**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
diff --git a/docs/blog/authors.yml b/docs/blog/authors.yml
@@ -0,0 +1,17 @@
+endi:
+  name: Endilie Yacop Sucipto
+  title: Maintainer of Docusaurus
+  url: https://github.com/endiliey
+  image_url: https://github.com/endiliey.png
+
+yangshun:
+  name: Yangshun Tay
+  title: Front End Engineer @ Facebook
+  url: https://github.com/yangshun
+  image_url: https://github.com/yangshun.png
+
+slorber:
+  name: Sébastien Lorber
+  title: Docusaurus maintainer
+  url: https://sebastienlorber.com
+  image_url: https://github.com/slorber.png
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -0,0 +1,39 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+A quick overview of SafeStep-- **SmartSocks for Diabetic Foot Monitoring**.
+
+## The Beginning
+
+![The Beginning](../static/img/delaware.png)
+
+It all started with a group of students from Columbus State University, much like the iconic depiction of **George Washington bravely crossing the Delaware**. Just as that pivotal moment was a turning point in history, our project represents a stride towards innovation in healthcare technology. As we navigate through the complexities of developing the SmartSock for diabetic foot monitoring, our journey echoes the daring and determination of those historical figures— with a bit less freezing river water and a lot more programming."
+
+## What is SafeStep?
+
+SafeStep is a **smart sock** that monitors the foot health of diabetic patients. It is designed to help prevent foot ulcers and amputations by providing real-time data on foot temperature and pressure.
+
+**_Maybe...insert image or video Here_**
+
+## How does it work?
+
+In theory, SafeStep works by monitoring the temperature and pressure of the foot. It uses sensors embedded in the sock to collect data, which is then transmitted to a mobile app via Bluetooth. The app analyzes the data and alerts the user if there are any signs of potential foot ulcers. Potential signs would be based on the user's standard of 'normal' foot temperature and pressure; which would be determined during a calibration period.
+
+## Tech Stack
+
+SafeStep uses a combination of hardware and software to function. The hardware includes the smart sock itself, which contains the sensors and Bluetooth transmitter. The software includes the mobile app, which receives and analyzes the data from the sock.
+
+- Android Studio
+- Flask
+- MongoDB
+
+**_Maybe...insert image or video Here_**
+
+## Continuous Innovation
+
+**SafeStep is a work in progress**. We are constantly working to improve the technology and make it more effective at detecting foot ulcers. We are also exploring new ways to use the data collected by the sock to help improve the overall health of diabetic patients.
+
+This project is a collaboration between students from Columbus State University and will be continued to be developed by either our team or future students.
diff --git a/docs/docs/tutorial-basics/_category_.json b/docs/docs/tutorial-basics/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Getting Started",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Quick start to setting up the SafeStep environment."
+  }
+}
diff --git a/docs/docs/tutorial-basics/android-app.md b/docs/docs/tutorial-basics/android-app.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+# Android App
+
+This section will cover the Android app for SafeStep. The app is the main software component of SafeStep and is responsible for receiving and analyzing data from the smart sock. The app is also responsible for alerting the user if there are any signs of potential foot ulcers.
diff --git a/docs/docs/tutorial-basics/architecture.md b/docs/docs/tutorial-basics/architecture.md
@@ -0,0 +1,49 @@
+---
+sidebar_position: 2
+---
+
+# Architecture
+
+![Architecture](../../static/img/Data-flow1.png)
+
+## System Overview
+
+1. The smart sock is the main hardware component of SafeStep. It contains sensors that monitor foot temperature and pressure. The data collected by the sensors is transmitted to a mobile app via Bluetooth. The app analyzes the data and alerts the user if there are any signs of potential foot ulcers.
+
+2. The mobile app is the main software component of SafeStep. It receives and analyzes the data from the smart sock. The app is responsible for alerting the user if there are any signs of potential foot ulcers.
+
+3. The web server backend is built with Flask. It is responsible for storing and retrieving data from the MongoDB database. The web server backend also provides an API for the mobile app to communicate with the database.
+
+4. The MongoDB database stores the data collected by the smart sock. The database is used to store historical data and provide insights into the user's foot health over time.
+
+5. The user interacts with the mobile app to view real-time data on their foot health. The app provides alerts and recommendations based on the data collected by the smart sock.
+
+6. The user can also view historical data and trends in the mobile app. This allows the user to track changes in their foot health over time and make informed decisions about their care.
+
+## Deep Dive into the components
+
+### Smart Sock
+
+The smart sock is the main hardware component of SafeStep. It contains sensors that monitor foot temperature and pressure. The sensors are embedded in the sock and collect data in real-time. The data is transmitted to a mobile app via Bluetooth.
+
+### Mobile App
+
+The mobile app is the main software component of SafeStep. It receives and analyzes the data from the smart sock. The app is responsible for alerting the user if there are any signs of potential foot ulcers. The app also provides real-time data on foot temperature and pressure.
+
+### Web Server Backend
+
+The web server backend is built with Flask. It is responsible for storing and retrieving data from the MongoDB database. The web server backend also provides an API for the mobile app to communicate with the database. The web server backend is hosted on a cloud server and is accessible via the internet.
+
+### MongoDB Database
+
+The MongoDB database stores the data collected by the smart sock. The database is used to store historical data and provide insights into the user's foot health over time. The database is hosted on a cloud server and is accessible via the internet.
+
+### User Interface
+
+The user interacts with the mobile app to view real-time data on their foot health. The app provides alerts and recommendations based on the data collected by the smart sock. The user can also view historical data and trends in the mobile app. This allows the user to track changes in their foot health over time and make informed decisions about their care.
+
+### Conclusion
+
+SafeStep is a comprehensive system that combines hardware and software to monitor the foot health of diabetic patients. The system provides real-time data on foot temperature and pressure and alerts the user if there are any signs of potential foot ulcers. The system also stores historical data and provides insights into the user's foot health over time. SafeStep is designed to help prevent foot ulcers and amputations by providing diabetic patients with the information they need to take care of their feet.
+
+**_Maybe...insert image or video Here_**
diff --git a/docs/docs/tutorial-basics/flask-backend.md b/docs/docs/tutorial-basics/flask-backend.md
@@ -0,0 +1,31 @@
+---
+sidebar_position: 5
+---
+
+# Flask Backend
+
+Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
+
+It builds your site as simple **static HTML, JavaScript and CSS files**.
+
+## Build your site
+
+Build your site **for production**:
+
+```bash
+npm run build
+```
+
+The static files are generated in the `build` folder.
+
+## Deploy your site
+
+Test your production build locally:
+
+```bash
+npm run serve
+```
+
+The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
+
+You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).