Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 1.63 KB

README.md

File metadata and controls

69 lines (46 loc) · 1.63 KB

IPMC

Interplanetary Media Center

GitHub Repo stars GitHub License

A piece of software made to access media libraries hosted on IPFS.

Screenshots

screenshot

Documentation

The documentation can be found here

Getting started

Prerequisites

  • nodejs >= v20.12.2
  • yarn (installed through corepack)

Clone the repository

git clone https://github.com/undyingwraith/ipmc.git
cd ipmc

Installing dependencies

yarn install

Running it in dev mode

yarn dev

Packages

Path Name Description
./packages/interfaces ipmc-interfaces Defines interfaces for MetaData and services.
./packages/core ipmc-core Contains Services and utilities.
./packages/ui ipmc-ui Contains a react app that acts as ui.
./packages/desktop ipmc-desktop Contains a electron app using the ipmc-ui.
./packages/webui ipmc-webui Contains a react app using the ipmc-ui.

Contributing

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/feature-name.
  3. Make your changes.
  4. Push your branch: git push origin feature/feature-name.
  5. Create a pull request.

License

This project is licensed under the MIT License.

Contributors