oss-slu · Taktar · Sep 30, 2024 · Oct 6, 2024 · Oct 7, 2024 · Oct 7, 2024
@@ -1 +1,2 @@
-* @jacksayshi
+* @jacksayshi
+* @UcheWendy
@@ -1,81 +1,81 @@
-# Contributing to Digital Bones Box
-
-Thank you for checking out **Digital Bones Box**! We are so happy you are here. If you are intrested in contributing to the project below are some guidelines that help us make most out of your contribution. 
-
-## Getting Started
-
-### How to Contribute
-
-### 1. **Fork the Repository**
-- Navigate to the Digital Bones Box repository on GitHub
-- Click the "Fork" button on the top right of the repository page to create your own copy.
-    
-
-### 2. **Clone Your Fork**
-- Clone the repository to your local machine:
-   ```bash
-   git clone https://github.com/oss-slu/DigitalBonesBox
-   cd your-repo
-
-
-### 3. Create a New Branch
-- Create a new branch for your contribution:
-  ```bash
-  git checkout -b feature-branch
-  ```
-
----
-
-## Contribution Workflow
-
-### 1.Choose an Issue associated with the label **hacktoberfest**
-- Choose the Issue associated with the label hacktoberfest and clearly read all the details and acceptance criteria for the issue before starting to work on the issue.
-  
-### 2. Make Your Changes
-- Work on your branch locally. Implement your changes and test them thoroughly to ensure they work correctly.
-- For any UI changes, please include screenshots in the pull request.
-
-### 3. Commit Your Changes
-- Commit messages should be clear and concise. Follow the format:
-  ```
-  git commit -m "Add feature X to improve performance"
-  ```
-- Make sure your commit is properly documented and explains the **why** and **what** of the changes.
-
-### 4. Push Your Changes
-- Push your branch to GitHub:
-  ```bash
-  git push origin feature-branch
-  ```
-
-### 5. Submit a Pull Request (PR)
-- Navigate to your fork on GitHub and click the **Pull Request** button.
-- Ensure your PR:
-  - References the related issue number (e.g., `Fixes #123`).
-  - Provides a clear description of what was changed and why.
-  - Includes relevant tests or screenshots where applicable.
-  - follow the Pull Request template.
-
----
-
-## Code Guidelines
-
-- Keep your code readable, maintainable, and well-documented.
-
-### 1. Documentation
-- Update documentation as necessary. If your change impacts functionality, be sure to update the corresponding documentation in the **Help** or **README** files.
-
----
-
-## Issue Reporting
-
-### 1. Suggesting Enhancements
-- If you have ideas for new features, improvements, or optimizations, submit them through a GitHub issue and tag it with **enhancement**.
-
----
-
-## Community
-
-- If you have any questions or need guidance, feel free to or reach out via email sritammiraja.iragavarapu@slu.edu 
-  
-Thank you for your contributions!
+# Contributing to Digital Bones Box
+
+Thank you for checking out **Digital Bones Box**! We are so happy you are here. If you are intrested in contributing to the project below are some guidelines that help us make most out of your contribution. 
+
+## Getting Started
+
+### How to Contribute
+
+### 1. **Fork the Repository**
+- Navigate to the Digital Bones Box repository on GitHub
+- Click the "Fork" button on the top right of the repository page to create your own copy.
+
+
+### 2. **Clone Your Fork**
+- Clone the repository to your local machine:
+   ```bash
+   git clone https://github.com/oss-slu/DigitalBonesBox
+   cd your-repo
+
+
+### 3. Create a New Branch
+- Create a new branch for your contribution:
+  ```bash
+  git checkout -b feature-branch
+  ```
+
+---
+
+## Contribution Workflow
+
+### 1.Choose an Issue associated with the label **hacktoberfest**
+- Choose the Issue associated with the label hacktoberfest and clearly read all the details and acceptance criteria for the issue before starting to work on the issue.
+
+### 2. Make Your Changes
+- Work on your branch locally. Implement your changes and test them thoroughly to ensure they work correctly.
+- For any UI changes, please include screenshots in the pull request.
+
+### 3. Commit Your Changes
+- Commit messages should be clear and concise. Follow the format:
+  ```
+  git commit -m "Add feature X to improve performance"
+  ```
+- Make sure your commit is properly documented and explains the **why** and **what** of the changes.
+
+### 4. Push Your Changes
+- Push your branch to GitHub:
+  ```bash
+  git push origin feature-branch
+  ```
+
+### 5. Submit a Pull Request (PR)
+- Navigate to your fork on GitHub and click the **Pull Request** button.
+- Ensure your PR:
+  - References the related issue number (e.g., `Fixes #123`).
+  - Provides a clear description of what was changed and why.
+  - Includes relevant tests or screenshots where applicable.
+  - follow the Pull Request template.
+
+---
+
+## Code Guidelines
+
+- Keep your code readable, maintainable, and well-documented.
+
+### 1. Documentation
+- Update documentation as necessary. If your change impacts functionality, be sure to update the corresponding documentation in the **Help** or **README** files.
+
+---
+
+## Issue Reporting
+
+### 1. Suggesting Enhancements
+- If you have ideas for new features, improvements, or optimizations, submit them through a GitHub issue and tag it with **enhancement**.
+
+---
+
+## Community
+
+- If you have any questions or need guidance, feel free to or reach out via email wendy.onwuagana@slu.edu or daniel.shown@slu.edu
+
+Thank you for your contributions!
@@ -0,0 +1,44 @@
+### Finding Your First Contribution
+Welcome to the DigitalBoneBox project! We're thrilled you're interested in contributing. This guide is designed to help you find and complete your first issue.
+
+### What is a "Good First Issue"?
+A "Good First Issue" is a task that has been specifically identified by our team as being a great entry point for new contributors. These issues are typically:
+
+1. Well-defined: The goal is clear and the scope is small.
+
+2. Low-impact: They don't involve changing critical parts of the application.
+
+3. A great learning opportunity: They are a perfect way to get familiar with our codebase, our contribution workflow, and our team.
+
+Examples of good first issues in this project might include:
+
+Fixing a typo in the UI.
+
+Improving the styling of a button or a menu.
+
+Adding a small, self-contained feature, like a "Back to Top" button.
+
+Improving the comments or documentation in a specific part of the code.
+
+### How to Find a Good First Issue
+We use a specific label on GitHub to mark these tasks. You can find a good first issue by looking at our wide range of issues created in our repo and identifying an issue tagged "Good First Issue".
+
+### Your First Contribution Workflow
+Once you've found an issue that interests you, here’s how to get started:
+
+1. Claim the Issue: Let everyone know you're working on it! You can assign the issue to yourself by clicking the "assign" button in the sidebar on the right of the issue page. It's also a good idea to leave a quick comment like, "I'd like to work on this!" This helps us avoid having multiple people working on the same thing.
+
+2. Follow the Contribution Guide: Our main CONTRIBUTING.md file has all the technical steps you need to get the project set up on your local machine. Please follow it carefully to fork the repository, create your branch, and run the application.
+
+3. Work on the Code: Make the necessary changes to the code to address the issue.
+
+4. Submit a Pull Request: Once you're finished, submit a pull request. we have a pull request template we use for our project which you can use for your reference under ISSUE_TEMPLATE. Once that is done, Our team will then review your work.
+
+### Questions or Need Help?
+We're here to help you succeed! If you get stuck, have a question, or just want to discuss an idea, please don't hesitate to:
+
+Leave a comment on the issue you're working on.
+
+Reach out to the project maintainers via the contact information in our CONTRIBUTING.md file.
+
+Thank you for your interest in contributing to DigitalBoneBox!
@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug + expected behavior**
+*A clear and concise description of what the bug is, and what you expected to happen.*
+
+**Steps to reproduce**
+*A list of steps it takes to see this bug.*
+
+**Additional context**
+*Add any other context or screenshots about the bug here.*
@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest a change to this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe the feature that you would like added**
+*A clear and concise description of the feature, and why is should be added to the project.*
+
+**Tasks that need to completed for this feature**
+*A list of individual tasks that likely must be done before the feature can be considered "complete".*
+
+**Additional context**
+*Add any other context or screenshots about the feature request here.*
@@ -0,0 +1,35 @@
+---
+name: General Task Card
+about: For standard development tasks, chores, or refactoring.
+title: '[Task]: '
+labels: task, enhancement
+assignees: ''
+
+---
+
+### 🎯 Goal / Objective
+*A clear and concise description of what this task aims to achieve. Why is this task important for the sprint?*
+
+---
+
+### ✅ Tasks to be Completed
+*A checklist of the specific, actionable steps required to complete this issue. This helps track progress.*
+
+- [ ] Task 1:
+- [ ] Task 2:
+- [ ] Task 3:
+
+---
+
+### Acceptance Criteria
+*A checklist of conditions that must be met for this task to be considered complete. How will we verify that it's done correctly?*
+
+- [ ] The new feature is implemented as described.
+- [ ] All related code passes the repository's workflow checks (linting, tests).
+- [ ] The application runs without errors after the changes are made.
+- [ ] (If applicable) New automated tests have been added to cover the changes.
+
+---
+
+### Additional Context
+*Add any other context, notes, screenshots, or links that might be helpful for completing this task.*
@@ -0,0 +1,27 @@
+name: Lint JavaScript
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run ESLint
+        run: npm run lint
@@ -1,4 +1,6 @@
 name: Lint JavaScript
+permissions:
+  contents: read
 on:
  push:
@@ -1,4 +1,6 @@
 name: Lint JavaScript
+permissions:
+  contents: read

 on:
  push:
@@ -1 +1,2 @@
 node_modules/
+.vscode/
@@ -1,2 +1,62 @@
-# DigitalBoneBox
+# DigitalBoneBox : A Web-Based Study Tool for Human Anatomy
+
 This project is a Web App project aims to convert an existing PowerPoint-based educational tool into an interactive, mobile-friendly web application.
+
+## How / why did we get here?
+
+This project is based on the work of Prof. Brian Elliott, created during his final years of education.
+In the human anatomy class, students must purchase a bone set to study the bones of the human body,
+but they are not allowed to take these models out of the lab. Prof. Elliott observed that this
+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.
+
+However, he wanted to make this resource even more accessible. He envisioned offering students a
+platform they could access on their iPads, or laptops—devices commonly used by students. This is
+where the web application comes in. It is designed to be a quick and easy guide for students to use
+for exams, to quiz themselves on essential knowledge, or to learn from material that is simple and
+provides an overview of the human bones. This application is based on the information in the
+presentations created by Prof. Brian Elliott.
+
+## Tech Stack
+
+This project was developed using the following technologies:
+
+Node.js: Used for server-side development to handle requests and serve the application.
+HTML: For structuring the content of the web pages.
+HTMX: A lightweight JavaScript library for enhancing interactivity by allowing partial page updates without a full page reload.
+CSS: For styling and layout of the web pages to ensure a clean and responsive design for users across devices.
+
+## Features
+
+Interactive and accessible web application for students to study human anatomy.
+Quick revision tool with annotated images of bones.
+Designed for use on iPads, laptops, or other devices commonly used by students.
+
+- **Toggle Sidebar**:
+  - A collapsible sidebar that enhances navigation within the app.
+  - Includes **placeholder options** such as **Search**, **Contact**, **Recent**, and **Help**, which are non-functional and reserved for future implementation.
+  - Users can open and close the sidebar using the ☰ button on the top-left corner of the page.
+
+## Setup:
+
+To run this project locally, you will need to have Node.js installed. The application consists of a backend API and a frontend client, which can be run together with a single command.
+
+1. Clone the repository:
+
+- git clone [https://github.com/oss-slu/DigitalBonesBox.git](https://github.com/oss-slu/DigitalBonesBox.git)
+- cd DigitalBonesBox
+
+2. Install dependencies:
+This command will install the necessary packages for both the root project and the boneset-api server.
+
+- npm install && npm install --prefix boneset-api
+
+3. Run the application:
+This command will start both the backend API server and the frontend live server concurrently.
+
+- npm start
+
+Your browser should automatically open to the application.
+
+## Contributing
+
+Contributions are welcome! Check out the CONTRIBUTING.md for guidelines.