Skip to content

Latest commit

 

History

History
250 lines (174 loc) · 9.16 KB

README.md

File metadata and controls

250 lines (174 loc) · 9.16 KB

Contributors Forks Stargazers Issues


Logo

Medulla Mentor

Brainstem histology can be a challenging concept for many medical students. I wanted to create a tool to help students better learn brainstem anatomy! Medulla Mentor is a cross-platform app designed in Flutter to allow for interactive visualization of the brainstem. Data is courtesy of the Duke Center for In Vivo Microscopy under CC By-NC-SA 3.0.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Brainstem anatomy is an integral part of medical education, where it aids in understanding clinical presentations and the pathophysiology of neurological disease. Despite advances in digital anatomy resources, current methods for learning the brainstem rely largely on flashcards and outdated histology slide websites. Medulla Mentor is a free-to-use, interactive website for students to learn brainstem anatomy in a modern digital environment.

(back to top)

Built With

  • Python
  • Flutter

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Medulla Mentor is built with Flutter for cross platform capability. Please install Flutter using the official guide.

  • Flutter Guide
    https://docs.flutter.dev/get-started/install
    

Installation

  1. Clone the repo
    git clone https://github.com/thesalmonification/medullamentor.git
  2. Install Flutter packages
    flutter pub get
  3. Run Medulla Mentor in Chrome
    flutter run -d chrome

(back to top)

Usage

Medulla Mentor can be accessed on the Web and as an iPad App.

The Web App can be found Here

The iPad App can be found here: AppStore

(back to top)

Roadmap

TODO

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Data of the Human Brainstem is courtesy of the Duke Center In Vivo Microscopy. The data is under the CC By-NC-SA 3.0 license, meaning any derived works are used for non-commercial and educational purposes only. Any use of the data must cite the original creators:

Adil et al 2021
https://doi.org/10.1016/j.neuroimage.2021.118135

Distributed under the CC By-NC-SA 3.0 license License. See LICENSE.txt for more information.

(back to top)

Contact

Duncan Salmon - duncanryansalmon@gmail.com

Project Link: https://github.com/thesalmonification/medullamentor

(back to top)

Acknowledgments

TODO

(back to top)