Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/entropic-dev/entropic

🦝 :package: a package registry for anything, but mostly javascript 🦝 🦝 🦝
https://github.com/entropic-dev/entropic

Last synced: about 23 hours ago
JSON representation

🦝 :package: a package registry for anything, but mostly javascript 🦝 🦝 🦝

Host: GitHub
URL: https://github.com/entropic-dev/entropic
Owner: entropic-dev
License: apache-2.0
Created: 2019-04-20T15:39:32.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-03T23:46:54.000Z (almost 2 years ago)
Last Synced: 2024-10-29T15:29:25.851Z (about 1 month ago)
Language: JavaScript
Homepage: https://discourse.entropic.dev/
Size: 2.43 MB
Stars: 5,290
Watchers: 114
Forks: 152
Open Issues: 163
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome - entropic - 🦝 :package: a package registry for anything, but mostly javascript 🦝 🦝 🦝 (JavaScript)
awesome-github-repos - entropic-dev/entropic - 🦝 :package: a package registry for anything, but mostly javascript 🦝 🦝 🦝 (JavaScript)
awesome-repositories - entropic-dev/entropic - 🦝 :package: a package registry for anything, but mostly javascript 🦝 🦝 🦝 (JavaScript)
awesome-list - entropic - dev | 5359 | (JavaScript)

README

        # Entropic: a federated package registry for anything

[![All Contributors](https://img.shields.io/badge/all_contributors-23-orange.svg?style=flat-square)](#contributors) [![Code of Conduct](https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat-square)](./.github/CODE_OF_CONDUCT.md)

A new package registry with a new CLI, designed to be easy to stand up inside your network. Entropic features an entirely new file-centric API and a content-addressable storage system that attempts to minimize the amount of data you must retrieve over a network. This file-centric approach also applies to the publication API. See the [API section of the manifesto](https://github.com/entropic-dev/entropic/tree/master/docs#apis) for more details about the API offered.

Entropic assumes many registries co-existing and interoperating as a part of your normal workflow. All Entropic packages are namespaced, and a full Entropic package spec also includes the hostname of its registry.

The legacy node package manager is treated as a read-only archive. You may install legacy packages through your Entropic home instance.

See [docs/README.md](docs/README.md) for the manifesto.

Are you interested in contributing? Do you have some feedback to share? Come talk with us in our [Discourse](https://discourse.entropic.dev/).

## What's working

Entropic is self-hosting. That means login, publication, and installation (mostly) are working. There are bugs, many unimplemented features, and the whole thing will probably fall over in a stiff breeze. We feel this is exceeding expectations for a project that's just over a month old.

Our development instance is running at `https://registry.entropic.dev/`. You'll probably all knock it over trying it out, I just know it.

## Overview

Package specifications are fully qualified with the namespace, hostname, and package name. They look like this: `[email protected]/pkg-name`. For example, the ds cli is specified by `[email protected]/ds`.

If you publish a package to your local registry that depends on packages from other registries, your local instance will proactively mirror all the packages yours depends on. The goal is to keep each instance entirely self-sufficient, so installs don't have to depend on a resource that might vanish. This is also true of packages installed from the legacy node package manager: they're given the namespace `legacy` and mirrored.

Abandoned packages are moved to the `abandonware` namespace.

Every Entropic user has a namespace that matches their user name. They may additionally belong to other namespaces. Packages can be updated by any user in the package's namespace. Packages can also have a list of maintainers.

For example, user `chris` owns the package `[email protected]/ds`. Chris can invite `ceejbot` to maintain `ds`. If ceejbot accepts, they'll be able to publish new versions of `ds`. Meanwhile, the package `[email protected]/lodash` can be maintained by anybody who's a member of the `lodash-people` namespace. This might include the user `jdalton` and anybody else jdalton invites. (We hear that jdd gets a dollar every time somebody uses lodash as an example.)

All packages published to Entropic are public. Our expectation is that you'll use something like the [GitHub Package Registry](https://help.github.com/en/articles/about-github-package-registry) if you need to control access to packages you publish. Or you might choose to run an Entropic instance and control access to it another way.

The only thing about Entropic that assumes you're managing javascript packages is the installer. We are open to adding other kinds of installers for other languages.

### The `ds` cli

See [INSTALLING](docs/installing/README.md) to install.

Log in to a registry: `ds login`. You will be prompted to authenticate using Github.

The `ds` cli is configured with an `.entropicrc` file in your home directory. This is a [TOML](https://github.com/toml-lang/toml) file. Use it to specify your preferred registry, as well as any other registries you use normally.

```toml

registry = "http://example.com"

[registries."https://entropic.dev"]

token = "a-valid-entropic-token"

[registries."http://example.com"]

token = "another-valid-entropic-token"

```

The cli doesn't have a very sensible shell for running commands yet, and it doesn't yet have working help. (Help for help welcomed!) You can see what commands are implemented by browsing [the command source folder](./cli/lib/commands). See the [cli readme](./cli/README.md) for more notes.

At present, if you want to install packages using `ds`, you can run `ds build` in a directory with a `Package.toml`. This will produce a `ds/node_modules` directory, which you can move into place by hand. This is a temporary situation!

### Packages

Packages are described by [TOML](https://github.com/toml-lang/toml) files giving metadata and listing dependencies.

Here's an example `Package.toml`:

```toml

name = "[email protected]/ds"

version = "0.0.0-beta"

[dependencies]

"@iarna/toml" = "^2.2.3"

"[email protected]/figgy-pudding" = "^3.5.1"

[...]

```

Publish a new package-version with `ds publish`.

## Contributing

Entropic is, at the moment of this writing, the work of two people: [Chris Dickinson](https://github.com/chrisdickinson) and [C J Silverio](https://github.com/ceejbot). They are not sponsored by anybody nor do they represent anyone but themselves. Chris and Ceej are seeking additional contributors but wish to onboard newcomers slowly. The project is new enough that clear direction does not always exist in the code, so contributors will need to work closely with us.

For more, see [Contributing](./.github/CONTRIBUTING.md) and our [Code of Conduct](./.github/CODE_OF_CONDUCT.md).

## Moderators

- **[ceejbot](https://github.com/ceejbot)**

- **[chrisdickinson](https://github.com/chrisdickinson)**

- **[toddself](https://github.com/toddself)**

- **[varjmes](https://github.com/varjmes)**

- **[aredridel](https://github.com/aredridel)**

## Contributors


_{Nick Schonning}
📖
_Sergey
💻
_James
📖 💻
_{Zac Anger}
💻
_{Todd Kennedy}
💻
_{Sébastien Cevey}
💻
_{Nikhil Ranjan}
💻
_{Nick Olinger}
💻
_{Jonathan Weiss}
💻
_{Andrew Nesbitt}
📖
_{Brenna Flood}
📖
_{Aaron Ross}
📖 💻
_{C J Silverio}
💻 📖
_{Chris Dickinson}
💻 📖
_{Aria Stewart}
💻
_{Pranshu Chittora}
📖
_{Kate Beard}
📖
_{Zeke Sikelianos}
💻
_{Sam Saccone}
📖
_{Mohamed Badawi}
💻
_{Wes Mason}
💻
_{Alfredo Miranda}
💻
_{Kirill Enykeev}
💻

## LICENSE

This project is released under the [Apache 2.0 license](./LICENSE).