Skip to content

Mithra is a simple static platform, to teach and to present scientific ideas.

License

Notifications You must be signed in to change notification settings

iskportal/Mithra-MVP

Repository files navigation

image

Mithra - The Black Board of the Internet

Overview

Mithra is a revolutionary digital blackboard inspired by Persian mythology's goddess of light. It allows users to present their ideas naturally, blending the spontaneity of live discussions with the flexibility of a digital platform. Just as scientists brainstorm and communicate by writing on blackboards, Mithra lets you do so over the internet without pre-made presentations or static notes.

Current Features

1. Dynamic Command Input

  • A command input box at the bottom allows users to type commands and display them on the blackboard by pressing enter.
  • Supports Markdown and LaTeX for mathematical expressions and formatted text.

2. Real-Time Content Sharing

  • Share text, formulas, and ideas in a seamless flow.
  • Write and present simultaneously, combining spoken words and written visuals.

3. Simple and Intuitive UI

  • A minimalist blackboard interface focusing on idea presentation.
  • Beta version designed for testing and feedback.

Planned Features for Future Releases

1. Enhanced Content Support

  • Image and video embedding.
  • Support for iframes to embed external content.

2. Notebook Editing and Re-Editing

  • Improved tools for editing and refining notes on the fly.

3. Runnable Code Snippets

  • Execute code snippets directly within the blackboard environment.

4. Live Network Presentations

  • Transition from a static page to real-time presentations over the network.

5. Zotero Integration

  • Plot and manage references seamlessly during presentations.

6. Theming Options

  • Multiple themes for different presentation environments.

Installation and Usage

Prerequisites

  • Modern web browser (Google Chrome, Firefox, etc.)

Installation

  1. Clone the repository:
    git clone https://github.com/ISK-Organization/Mithra.git
  2. Navigate to the project directory:
    cd Mithra
  3. Start the local server:
    npm install
    npm run dev
  4. Open your browser and go to http://localhost:5173/canvas to access the Mithra blackboard.

Usage

  1. Type your content in the input box at the bottom of the page.
  2. Use Markdown syntax for text formatting and LaTeX for mathematical expressions.
  3. Press enter to display your content on the blackboard.

Examples

Markdown Example

## Hello World
This is a sample markdown heading.

LaTeX Example

F = ma

Contribution Guidelines

We welcome contributions to Mithra to improve its functionality and user experience.

  1. Fork the repository.
  2. Create a feature branch:
    git checkout -b feature-name
  3. Commit your changes and push the branch:
    git commit -m "Add feature"
    git push origin feature-name
  4. Submit a pull request.

License

Mithra is a free and open-source project developed by the Independent Society of Knowledge (ISK).

Version

Mithra Beta v0.1.0

Contact

For more information or to report issues, please contact the Independent Society of Knowledge at [ISK website/contact page].

About

Mithra is a simple static platform, to teach and to present scientific ideas.

Resources

License

Stars

Watchers

Forks

Packages

No packages published