Skip to content

About

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

NeuroAtlas

The project aims to create an innovative and interactive platform that, based on 3D visualizations and a "Digital Twin" module, will allow users to monitor and understand the biochemistry of their brain based on daily habits and events.

Core Features (MVP)

  • Interactive Brain Model with Situational Simulation
    • Visualizations of the effects of psychoactive substances, emotions, diseases, and other physiological states on the brain directly on the 3D model.
  • Good and Bad Habits
    • Showcasing habits to adopt and those to avoid, along with their percentage impact values (if available) and highlighting the responsible brain parts.
  • Digital Brain Twin (Digital Twin)
    • Generating a dynamic model of your brain for a specific day, based on a daily log (e.g., hours slept, cups of coffee).

Technologies and Architecture

  • Frontend: React.js, TypeScript, Tailwind CSS, Vite
  • 3D Brain Library: React Three Fiber (R3F) + Three.js
  • Backend: Python (FastAPI)
  • Code Quality: ESLint

Documentation and Project Structure

More details about the project specification can be found in the docs/ folder:

Getting Started

Installation and Code Execution

1. Clone the repository

git clone https://github.com/Veresek/NeuroAtlas.git
cd NeuroAtlas

2. Run the project

cd client
docker compose up --build

Contributing

The project is currently in the MVP phase and is not open for external pull requests. However, if you have an idea for a feature or want to share your knowledge, reach out to me via the contact details provided in the Contact section.

License

This project is licensed under the GPL-3.0 license - see the LICENSE file for details.

Contact

About

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages