Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ipfs/ecosystem-directory

Interactive showcase of projects and products built using IPFS, the InterPlanetary File System.
https://github.com/ipfs/ecosystem-directory

decentralized dweb ipfs web3

Last synced: 21 days ago
JSON representation

Interactive showcase of projects and products built using IPFS, the InterPlanetary File System.

Host: GitHub
URL: https://github.com/ipfs/ecosystem-directory
Owner: ipfs
Created: 2021-03-10T01:03:00.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-06-03T17:59:49.000Z (7 months ago)
Last Synced: 2024-12-17T11:40:17.095Z (25 days ago)
Topics: decentralized, dweb, ipfs, web3
Language: HTML
Homepage: https://ecosystem.ipfs.tech
Size: 10.9 MB
Stars: 15
Watchers: 12
Forks: 8
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# IPFS Ecosystem Directory

Interactive IPFS ecosystem directory and showcase

**Just want to add a new project to the IPFS ecosystem directory? [Use this form](https://ipfs.fyi/ecosystem-form).**

***

## Project Add/Change Workflow

The existing workflow for adding a project to the ecosystem directory, or amending an existing project, is as described below.

### Adding a New Project
- Project info is added to the [master IPFS project database](https://airtable.com/tblxBjPTzHXiUVZAA/viwpijXTIFraPRkhE?blocks=hide) in one of two ways:
- Directly in the base as a new row
- By requesting a project's representative fill in the [IPFS Ecosystem Directory Submission Form](https://airtable.com/shrjwvk9pAeAk0Ci7)
- Once a record is added to the database, an IPFS core team member reviews the record for accuracy, consistency, typos, etc, as well as determining whether the project should be included in the directory (a decision largely based on project maturity)
- If the project is approved to be included in the directory (the "Include in directory" checkbox is ticked), a PR will be created automatically with the JSON by the [script](./scripts/fetch-from-airtable.js) which is run by [GitHub Actions](https://github.com/ipfs/ecosystem-directory/actions/workflows/airtable-pull.yml).

### Amending an Existing Project

- Project info should be amended in the [IPFS Builder Database (Ecosystem page)](https://airtable.com/tblxBjPTzHXiUVZAA/viwpijXTIFraPRkhE?blocks=hide) as a single source of truth
- From there, update the project details and a PR will be created automatically by GitHub Actions (within 24 hours). You can also trigger the [GitHub Action](https://github.com/ipfs/ecosystem-directory/actions/workflows/airtable-pull.yml) manually by clicking `Run workflow`.

***

## Generating the Showcase Grid

To view all projects in the ecosystem directory in a "logo parade" showcase format suitable for including in a slide deck, [see the instructions below](#Showcase) — this includes how to customize the grid to get the representation that's most useful for you.

TLDR: https://ecosystem.ipfs.tech/showcase/?category=focus is a general-purpose, useful grid if you don't want to build a custom one.

## Behavior

- The showcase view is visible in its bare form at [ecosystem.ipfs.tech/showcase](https://ecosystem.ipfs.tech/showcase)
- It provides a logo-based visual summary of the projects in the app by category
- Each tag within the selected category is assigned a block
- The container for the tag is sized based on whether there's a small, medium, or large quantity of projects within it

## Customization

### Category

Customizing the view is done using GET parameters. You might notice that the base showcase link feels a little empty.

Adding a target top-level `category` param to showcase solves this issue. Examples:
- [/showcase/?category=industry](https://ecosystem.ipfs.tech/showcase/?category=industry)
- [/showcase/?category=focus](https://ecosystem.ipfs.tech/showcase/?category=focus)
- [/showcase/?category=benefits](https://ecosystem.ipfs.tech/showcase/?category=benefits)

> Note: This category selection will work for _both_ categories that allow one tag per project (category in which tags are mutually exclusive) and categories that allow multiple tags.

### Containers

Instances of this app may have varying quantities of projects. To help the showcase address both large and small ecosystems, there are params that define container limits. These define what the limits are in terms of number of projects that fit into medium, or large containers.

- `md` minimum projects with a tag to display in a medium container (default is 10, if no value is provided)
- `lg` minimum projects with a tag to display in a large container ((default is 25, if no value is provided)

Example use case: [/showcase/?category=focus&md=5&lg=15](https://ecosystem.ipfs.tech/showcase/?category=focus&md=5&lg=15)

> Note: The Showcase view is designed to support rows of 5 logos, so setting `lg` and `md` as multiples of 5 is recommended for the ideal visual appearance.

### Location

- The showcase path may be redefined in the app's `settings.json` under the key `showcaseBaseRoute`
- Currently implemented as: `"showcaseBaseRoute": "/showcase"`
- The showcase has no links, and is not discoverable by search engines

***

## General Developer Information

### Deployment

This repo is currently deployed to Fleek on the following URLs:

`main` branch: https://ecosystem.ipfs.tech/

`develop` branch: https://ipfs-ecosystem-develop.on.fleek.co/

Pushes made to the `main` or `develop` branches of this repo will automatically be reflected in the URLs above. Please allow 2-5 minutes for the application to re-build before seeing changes in your browser.

### Server

**Ports**

These apply to local development.

```
development: 20000
stable: 20001
production: 20002
```

**Mode**: `static`

**Environment Variables**

```
NODE_ENV → development|production
SERVER_ENV → development|stable|production
```

***

## Getting Started

### A. Get Repo

In a terminal, run the commands below to get set up

```bash
# Navigate to directory within which to clone the git repo.
$ cd ~/Desktop

# Clone the repo
$ git clone [email protected]:ipfs/ecosystem-directory.git

# Enter the repo directory
$ cd ecosystem-directory

# Add your user information
$ git config user.name "Your Name"
$ git config user.email "[email protected]"

# Install npm dependencies
$ npm ci
```

### B. Generating a self-signed SSL certificate

Used for development in a local environment (such as on your personal computer). You only need to do this once. If you've already done this for a different project, just copy your existing `localhost_cert.pem` and `localhost_key.pem` files from `~/.ssh` into the root directory of this repo and skip the rest of this step.

1. [Install mkcert and generate certificate](https://github.com/FiloSottile/mkcert) by running the commands below, in that order:

```bash
$ cd ~/.ssh
$ brew install mkcert
$ mkcert -install
$ mkcert -key-file localhost_key.pem -cert-file localhost_cert.pem localhost 127.0.0.1
$ cat localhost_cert.pem > localhost_fullchain.pem
$ cat "$(mkcert -CAROOT)/rootCA.pem" >> localhost_fullchain.pem
```

2. Copy the new `localhost_cert.pem` and `localhost_key.pem` files to the root directory of this repo
3. Start the server and navigate to `https://localhost:`

### C. Environment variables

Create a file called `.env` and put it into the root directory of this repo. Add the following environment variables:

```
NODE_ENV=development
SERVER_ENV=development
```

### D. Start the app

```bash
$ npm run dev
```

***

## Project Model

Below is an outline of the project model. A boilerplate JSON file can be found in `@/static/project-template.json`. This template file can be duplicated, filled out and renamed to create a new project. It is not necessary to generate a project ID since the filename of each project will serve as a project `slug`. The project logo must be placed in the `@/static/images/projects` directory and committed to git. Just the logo name (ex: `project-logo.svg`) needs to be added to the project JSON file, no need to write out the full path.

### Naming Convention

This means that file names must be named after project names, and use lowercase and kebab-case. For example, an appropriate project `slug` would be `world-wide-web`, and therefore the corresponding file would be `world-wide-web.json`. It's important to not deviate between the file name and the `name` of the project.

### Keys

Keys should be retained when not in use. This ensures that if anyone wants to add to the project, they immediately see all keys available in other projects, rather than searching for the model or accidentally using a data structure that doesn't match the model perfectly. This means empty and type checking is done by the app in a strict fashion.

- `display`: toggle whether or not to display or hide the project from the results

- `featured`: toggle whether this appears in the featured slider

- `sortNumbers`: these labels and numbers will be used in the sort-by filter

- `logo`: all logos will be in SVG format and must be placed in the `@/static/images` directory

- `name`: name of the product

- `org`: a product can belong to multiple organizations

- `description`: 2 descriptions are needed. A long description that will be visible on the Project Single page and a short description that is visible in the card format (such as the Featured slider). If none provided, a truncated version of the long description will be used.

- `primaryLink`: this is the 1st link found directly under the project description

- `links`: these links will always appear at the top of the **Key Info** section, however, these links could be extended to use elsewhere in the future

- `keyInfo`: these key/value pairs will always appear below the links in the **Key Info** section

- `video`: can be a URL to either a YouTube or Vimeo video, the video must be publicly accessible and embeddable

- `stats`: general statistics with short descriptions, also known as "big numbers"

- `ctaCard`: this card will always be displayed as the last block in the stats section. The button text can be changed in `@/content/pages/project.json`

- `taxonomies`: the taxonomies contain a `slug` that will match a master taxonomy object (found in: `@/content/pages/taxonomy.json`); if a tag does not match, it will not be displayed. In other words, `taxonomy.json` acts as a source of truth, regardless of the tags assiged in a particular project's content.

### Schema

The schema can be found [here](https://github.com/ipfs-shipyard/nuxt-module-ecosystem-directory/blob/main/content/data/project-schema.json) and _must_ be updated if the schema ever changes. The `$setProjectDefaults()` global method (found [here](https://github.com/ipfs-shipyard/nuxt-module-ecosystem-directory/blob/main/plugins/helpers.js)) uses [`project-schema.json`](https://github.com/ipfs-shipyard/nuxt-module-ecosystem-directory/blob/main/content/data/project-schema.json) in order to perform type checking.

```ts
{
display: Boolean,
featured: Boolean,
sortNumbers: {
label: Number
},
logo: {
icon: String,
full: String
},
name: String,
org: [String],
description: {
short: String,
long: String
},
primaryCta: {
url: String,
text: String
},
links: [ {
label: String,
links: [ {
url: String,
text: String
} ]
} ],
keyInfo: [ {
label: String,
value: String
} ],
video: String,
stats: [ {
label: String,
value: String
} ],
ctaCard: {
title: String,
description: String,
buttonText: String,
url: String
},
taxonomies: [{
slug: String,
tags: [String]
}]
}
```

***

## Transforming Project Data

Each project that is to be included in the ecosystem must have a `json` file in `@/content/projects`, with the project name in `kebab-case`. For instance, `@/content/projects/foo-bar.json`.

***

## Embeddable View

An interactive summary of the state of the app can be injected into external sites. It contains a slider with sample projects that can be filtered by one dimension, and sorted. This view is embeddable in 2 steps:

1. Include a single Javascript file in the external site, from the path `/embeddable-view.js`

2. Specify a target container on the external site, with either a class or _id_ as follows
- `class="ipfs-ecosystem-embed"`
- `id="ipfs-ecosystem-embed"`

### Customization

The content for the embeddable view, and target category for the dropdown, can be specified in the `embeddable-view-settings.json` file.

The embeddable view inherits the theming from the Ecosystem itself, but is also available in a light and a dark mode
- For light mode (default), `data-theme="light"` can be added to the target container
- For dark mode, add `data-theme="dark"` to the target container

On the external site, it might be useful to provide a `max-width` for the container
```css
.ipfs-ecosystem-embed, #ipfs-ecosystem-embed {
max-width: 600px;
}
```

If a class is used, multiple embeddable views can be instantiated on a single page. This is also useful for support of single page applications. The following HTML will call in two embeddable views, one light, and the other dark.

```html

```

- The embeddable view is namespaced to avoid conflicts
- This view calls in VueJS on the target site. If Vue is already loaded, it does not call it in
- As such, this view is loosely compatible with legacy Vue 1 as well as Vue 3 sites (more extensive testing may need to be performed)
- This view is compatible with all modern browsers, and many older browsers, including Internet Explorer 11

***

## Showcase

This application is shipped with an alternative data visualization, for the purpose of use in presentations and other media where a visual summary of the projects in the ecosystem is needed.

By default this view is called the _Showcase_, which is also the URL through which it's accessed. This path _can_ be changed.

### Behavior

### Customization

#### Category

Customizing the view is done using GET parameters. The base showcase path will render projects, but may seem bare if no arguments are passed in the URI.

> Note: This category selection will work for _both_ categories that allow one tag per project (category in which tags are mutually exclusive) and categories that allow multiple tags.

#### Containers

Example use case: [/showcase/?category=focus&md=5&lg=15](https://ecosystem.ipfs.tech/showcase/?category=focus&md=5&lg=15)

> Note: The Showcase view is designed to support rows of 5 logos, so setting `lg` and `md` as multiples of 5 is recommended for the ideal visual appearance.

#### Location

***

## Analytics

Analytics are implemented through Countly, using the Web SDK.

The following environment variables are required:

```bash
NODE_ENV=
COUNTLY_APP_KEY=
COUNTLY_SITE_URL=
```

The following `nuxt.config.js` entries are required:

```js
{
countly: {
initialize: true, // if set to false, Countly will be DISABLED
debug: Boolean,
disableInDevelopment: Boolean,
suppressErrorLogs: Boolean
}
}
```

Below is a breakdown of all events captured by Countly.

### → General

```js
Countly.track_sessions()
Countly.track_pageview()
Countly.track_links()
```

### → Segment Chart

**Segment clicked**

`name: `

`slug: `

```js
Countly.trackEvent('Segment Chart | Segment Clicked', { label, slug })
```

**View All button clicked**

`name: `

`slug: `

```js
Countly.trackEvent('Segment Chart | View All Button Clicked', { label, slug })
```

### → Featured Slider

**Project card clicked**

`name: `

`slug: `

`from: Home Page | Detail Page`

```js
Countly.trackEvent('Featured Slider | Project Card Clicked', { name, slug, from })
```

### → Events

**Filter Panel Toggled**

`button: filters | x-icon | done`

`state: open | closed`

```js
Countly.trackEvent('Filter Panel Toggled', { button, state })
```

**Sort-By Dropdown Toggled**

`state: open | closed`

```js
Countly.trackEvent('Sort-By Dropdown Toggled', { state })
```

**Sort-By Option Selected**

`label: `

`slug: `

```js
Countly.trackEvent('Sort-By Option Selected', { label, slug })
```

**Pagination Button Clicked**

`page: `

```js
Countly.trackEvent('Pagination Button Clicked', { page })
```

**Results-Per-Page Dropdown Toggled**

`state: open | closed`

```js
Countly.trackEvent('Results-Per-Page Dropdown Toggled', { state })
```

**Results-Per-Page Option Selected**

`option: `

```js
Countly.trackEvent('Results-Per-Page Option Selected', { option })
```

**Grid-List View Toggled**

`view: list | grid`

```js
Countly.trackEvent('Grid-List View Toggled', { view })
```

**Filter Chiclet Clicked**

`tag: all | `

`category: `

`state: on | off`

```js
Countly.trackEvent('Filter Chiclet Clicked', { tag, category, state })
```

**Clear Filters Button Clicked**
`count: `

```js
Countly.trackEvent('Clear Filters Button Clicked', { count })
```

**Filter Panel Search Input**

There exists a 500ms debounce function in the search input so as to provide a greater chance of capturing a full rather than partial search query.

`query: `

```js
Countly.trackEvent('Filter Panel Search Input', { query })
```

### → Header/Footer

Links get automatically tracked by `Countly.track_links()`

### → 404

```js
Countly.trackEvent('404_NOT_FOUND', {
path: this.$route.path,
referrer: document.referrer
})
```

### → Query params

Track URL entire query param object when interacting with project filtering system. Since every param change is already tracked individually as per the list above, this tracker exists as an added layer for testing.

`query: Object`

```js
Countly.trackEvent('Query Param Debug', { query })
```