npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@devprotocol/clubs-plugin-posts

v0.20.19

Published

Template repository for using TypeScript

Downloads

2,855

Readme

Clubs Plugin Posts

Local Development

Setting up your config

This assumes you have created a Club. You'll need your property token address for this. Go to /preview/config.ts, and enter your property address.

Creating DB Indexes

If you are using your own Redis instance for local development, you need to create indexes. First, add your REDIS details to the .env file. Next, run yarn run preview to start the server. Finally, in a separate terminal window, run the following:

curl -X POST -H "Content-Type: application/json" http://localhost:3000/api/devprotocol:clubs:plugin:posts/indexing/documents:redis

Plugin configuration

{
	key: 'feeds',
	value: [
		{
			id: 'default',
			database: {
				key: 'DATABASE_KEY', // i.g., posts::694666bb-b2ec-542b-a5d6-65b470e5c494
			}
		},
		{
			id: 'my-hobby',
			database: {
				key: 'DATABASE_KEY', // i.g., posts::694666bb-b2ec-542b-a5d6-65b470e5c494
			}
		},
		{
			id: 'travel',
			database: {
				key: 'INDEX_SCOPE', // i.g., scope::694666bb-b2ec-542b-a5d6-65b470e5c494
			}
		},
	]
}

Structure of Post item

type Posts = {
	readonly id: string
	readonly title: string
	readonly content: string
	readonly options: readonly {
		readonly key: string
		readonly value: ClubsGeneralUnit
	}[]
	readonly created_by: string
	readonly created_at: Date
	readonly updated_at: Date
	readonly comments: readonly {
		readonly content: string
		readonly options: readonly {
			readonly key: string
			readonly value: ClubsGeneralUnit
		}[]
		readonly id: string
		readonly created_by: string
		readonly created_at: Date
		readonly updated_at: Date
	}[]
	readonly reactions: readonly {
		[emoji: string]: string[] // for example {'🦜': ['0x0', '0x2']}
	}
}

Naming convention for option keys

Option keys can use any string, but for creating private options, a reserved naming convention "starts with #" works. If the option key has a leading "#", the plugin's server-side process returns those values to only authenticated users. This is useful for posting token-gated posts.

{
	...
	options: [
		{
			/**
			 * Unauthenticated users cannot access these values 🤫
			 */
			key: "#images",
			value: [
				'https://example.image/special1.png',
				'https://example.image/special2.png',
				'https://example.image/special3.png'
			]
		}
	]
}