Skip to content

Commit

Permalink
move showcase data off contentful (dfinity#956)
Browse files Browse the repository at this point in the history
* move showcase data off contentful

* tweak showcase guidelines

* Update showcase.json (dfinity#959)

* design update

* fix style/code bugs

* fix meta title + share image

* fix video dom element

* Edited list of showcase projects + new covers and logos

+ made a description text smaller

* More logo updates

* fix width overflow

* fix large image layout

* Change the title

* add disclaimer

* fix tooltips cut off

* fix filename of sly logo

* update readme link

* Update showcase.json (dfinity#1058)

* Update showcase.json

* Update showcase.json

* Update showcase.json

* Update plethora stats & one liner + logos update

---------

Co-authored-by: gomyeji <[email protected]>
Co-authored-by: Artem Korotkikh <[email protected]>
  • Loading branch information
3 people authored Feb 14, 2023
1 parent e94bb49 commit 599b607
Show file tree
Hide file tree
Showing 197 changed files with 1,505 additions and 2,582 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,3 +187,62 @@ Please make sure to add appropriate tags to make the tool easy to discover for o
You can submit your sample project to be displayed on the [Samples page](https://internetcomputer.org/samples).

Add your submission to [the community projects file](/community/communityProjects.ts) and open a pull request. You can use an editor with TypeScript support to make sure your submission follows [the schema](/src/components/Common/sampleItems.ts).

## Showcase submission guidelines

_Disclaimer: You should have a working canister for your product to be showcased. Our team will review the PR and get back to you for any further questions. In the meantime, please contact [email protected] if you have any questions._

Add your project to the end of [`showcase.json`](/showcase.json). Refer to the object schema below for the required fields.

Make up a unique project id. For example, if your project is called `Awesome ICP Project!`, your project id could be `awesome-icp-project`.

Your logo/video/screenshots files should be prefixed with your project id, and placed in the `/static/img/showcase` folder. For example, if your project id is `awesome-icp-project`, your logo file should be named `awesome-icp-project_logo.webp` and placed in the `/static/img/showcase` folder.

### Asset guidelines

| Asset | | Requirements | Format | Notes |
| ----------- | -------- | ------------ | ------------ | --------------------------------------------------------------------------------- |
| logo | required | 112x112px | webp/svg/png | Currently displayed 56x56px |
| screenshots | optional | 1024x576px | webp/jpg | The schema supports multiple files, but only the first one will be displayed |
| video | optional | max 10MB | webm/mp4 | If there is a video file specified, it will be displayed instead of a screenshot. |

### Tags

The list of tags is not final, and will be updated as the project evolves. For now, the following tags are available:

- `Wallet`
- `NFT`
- `SocialFi`
- `DeFi`
- `Games`
- `DAO`
- `Metaverse`
- `Tools / Infrastructure`

### Object schema

```
{
id: string,
name: string,
oneLiner: string, // short description of the project
website: string, // URL starting with `https://`
tags: ('Wallet' | 'NFT' | 'SocialFi' | 'DeFi' | 'Games' | 'DAO' | 'Metaverse' | 'Tools / Infrastructure')[],
description: string, // description of the project
usesInternetIdentity: boolean,
stats: string, // eg. "10,000 users"
logo: string, // url to logo file, eg. /img/showcase/awesome-icp-project_logo.webp
github?: string, // full URL to github repo, if available
youtube?: string, // full URL to a YouTube video or channel, if available
twitter?: string, // full URL to a twitter account, if available
screenshots?: string[], // optional array of urls to screenshot files
video?: string, // optional url to video file, eg. /img/showcase/awesome-icp-project_video.webm
videoContentType?: 'video/webm' | 'video/mp4', // to feed into the type attribute of the video/source element
submittableId?: string, // optional id of the submittable form
},
```
4 changes: 1 addition & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ const versions = require("./versions.json");
const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const simplePlantUML = require("@akebifiky/remark-simple-plantuml");
const showcaseProjectsPlugin = require("./plugins/showcase-projects");
const homeShowcaseProjectsPlugin = require("./plugins/home-showcase");
const icpPricePlugin = require("./plugins/icp-price");
const xdrPricePlugin = require("./plugins/xdr-price");
Expand Down Expand Up @@ -62,7 +61,6 @@ const config = {
tailwindPlugin,
icpPricePlugin,
xdrPricePlugin,
showcaseProjectsPlugin,
homeShowcaseProjectsPlugin,
liveSessionsPlugin,
howItWorksArticlesPlugin,
Expand Down Expand Up @@ -167,7 +165,7 @@ const config = {
label: "Explore",
items: [
{
label: "Web3 Ecosystem",
label: "ICP Ecosystem",
href: "/ecosystem",
},
{
Expand Down
58 changes: 0 additions & 58 deletions plugins/data/home-showcase-mock.json

This file was deleted.

Loading

0 comments on commit 599b607

Please sign in to comment.