https://github.com/undyingwraith/ipmc

A piece of software made to access media libraries hosted on IPFS
https://github.com/undyingwraith/ipmc

helia ipfs libp2p

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/undyingwraith/ipmc
• Owner: undyingwraith
• Created: 2023-11-27T09:58:18.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-17T11:52:39.000Z (8 months ago)
• Last Synced: 2024-10-19T15:43:57.442Z (8 months ago)
• Topics: helia, ipfs, libp2p
• Language: TypeScript
• Homepage:
• Size: 2.41 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# IPMC

Interplanetary Media Center

![GitHub Repo stars](https://img.shields.io/github/stars/undyingwraith/ipmc)

![GitHub License](https://img.shields.io/github/license/undyingwraith/ipmc)

A piece of software made to access media libraries hosted on [IPFS](https://ipfs.io).

## Screenshots

![screenshot](./docs/images/screenshot1.png)

## Documentation

The documentation can be found [here](./docs/README.md)

## Getting started

### Prerequisites

- nodejs >= v20.12.2

- yarn (installed through [corepack](https://yarnpkg.com/corepack))

### Clone the repository

```shell

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

cd ipmc

```

### Installing dependencies

```shell

yarn install

```

### Running it in dev mode

```shell

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](LICENSE).

## Contributors