Skip to content

Commit 6fa05b6

Browse files
authored
Merge pull request #122 from mvolkmann/main
fixed whitespace in README
2 parents cca24fc + bf7d09e commit 6fa05b6

File tree

2 files changed

+813
-15
lines changed

2 files changed

+813
-15
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
# DigitalBoneBox : A Web-Based Study Tool for Human Anatomy
2+
23
This project is a Web App project aims to convert an existing PowerPoint-based educational tool into an interactive, mobile-friendly web application.
34

4-
## How / why did we get here?
5+
## How / why did we get here?
56

6-
This project is based on the work of Prof. Brian Elliott, created during his final years of education.
7-
In the human anatomy class, students must purchase a bone set to study the bones of the human body,
8-
but they are not allowed to take these models out of the lab. Prof. Elliott observed that this
7+
This project is based on the work of Prof. Brian Elliott, created during his final years of education.
8+
In the human anatomy class, students must purchase a bone set to study the bones of the human body,
9+
but they are not allowed to take these models out of the lab. Prof. Elliott observed that this
910
restriction could cause inconvenience for students who want to quickly review the bones before an exam. To address this, he created a PowerPoint presentation that includes images of the bones taken from different angles (with permission from the department), and he annotated these images to highlight the various bones in the set using different colors and filters. He utilized all available features to create an easily accessible presentation that students could use for quick revision or brief study sessions before tests.
1011

11-
However, he wanted to make this resource even more accessible. He envisioned offering students a
12-
platform they could access on their iPads, or laptops—devices commonly used by students. This is
13-
where the web application comes in. It is designed to be a quick and easy guide for students to use
14-
for exams, to quiz themselves on essential knowledge, or to learn from material that is simple and
15-
provides an overview of the human bones. This application is based on the information in the
12+
However, he wanted to make this resource even more accessible. He envisioned offering students a
13+
platform they could access on their iPads, or laptops—devices commonly used by students. This is
14+
where the web application comes in. It is designed to be a quick and easy guide for students to use
15+
for exams, to quiz themselves on essential knowledge, or to learn from material that is simple and
16+
provides an overview of the human bones. This application is based on the information in the
1617
presentations created by Prof. Brian Elliott.
1718

1819
## Tech Stack
20+
1921
This project was developed using the following technologies:
2022

2123
Node.js: Used for server-side development to handle requests and serve the application.
@@ -24,21 +26,23 @@ HTMX: A lightweight JavaScript library for enhancing interactivity by allowing p
2426
CSS: For styling and layout of the web pages to ensure a clean and responsive design for users across devices.
2527

2628
## Features
29+
2730
Interactive and accessible web application for students to study human anatomy.
2831
Quick revision tool with annotated images of bones.
2932
Designed for use on iPads, laptops, or other devices commonly used by students.
33+
3034
- **Toggle Sidebar**:
3135
- A collapsible sidebar that enhances navigation within the app.
3236
- Includes **placeholder options** such as **Search**, **Contact**, **Recent**, and **Help**, which are non-functional and reserved for future implementation.
3337
- Users can open and close the sidebar using the ☰ button on the top-left corner of the page.
3438

35-
36-
3739
## Setup
40+
3841
Clone the repository:
42+
3943
- git clone [https://github.com/oss-slu/DigitalBonesBox.git](https://github.com/oss-slu/DigitalBonesBox.git)
4044
- Open the project in your preferred code editor.
4145

4246
## Contributing
43-
Contributions are welcome! Check out the CONTRIBUTING.md for guidelines.
4447

48+
Contributions are welcome! Check out the CONTRIBUTING.md for guidelines.

0 commit comments

Comments
 (0)