Skip to content

Commit 55ee686

Browse files
jemgillamjemgillam
committed
initial commit
1 parent a661574 commit 55ee686

File tree

1 file changed

+149
-0
lines changed

1 file changed

+149
-0
lines changed

‎funding.json

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
{
2+
"version": "v1.0.0",
3+
4+
// Required. The entity associated with the project, soliciting funds.
5+
// This can be an individual, organisation, community etc.
6+
"entity": {
7+
"type": "organisation", // Required. [individual, group, organisation, other]. Use the closest approximation.
8+
"role": "owner", // Required. [owner, steward, maintainer, contributor, other]. Use the closest approximation.
9+
"name": "Graphile", // Required. Name of the entity. Max len 250.
10+
"email": "[email protected]", // Required. Max len 250.
11+
"phone": "", // Optional. Generally suitable for organisations. Max len 32.
12+
"description": "At Graphile we love GraphQL so much we named ourselves for our love of it!", // Required. Information about the entity. Max len 2000.
13+
"webpageUrl": {
14+
"url": "https://graphile.org", // Required. Webpage with information about the entity. Starts with https:// or http://. Max len 250.
15+
"wellKnown": "" // Optional. Required if the above url and the URL of the funding.json manifest do not have the same hostname. Starts with https:// or http://. Max len 250.
16+
}
17+
},
18+
19+
// Optional. One or more projects for which the funding is solicited.
20+
"projects": [
21+
{
22+
"guid": "graphile-worker", // Required. A short unique ID for the project. Lowercase-alphanumeric-dashes only. eg: my-cool-project. Max len 32.
23+
"name": "Graphile Worker", // Required. Name of the project. Max len 250.
24+
"description": "Job queue for PostgreSQL running on Node.js - allows you to run jobs (e.g. sending emails, performing calculations, generating PDFs, etc) in the background so that your HTTP response/application code is not held up. Can be used with any PostgreSQL-backed application.", // Required. Description of the project. Max len 2000.
25+
"webpageUrl": {
26+
"url": "https://worker.graphile.org/", // Required. Webpage with information about the project. Starts with https:// or http://. Max len 250.
27+
"wellKnown": "" // Optional. Required if the above url and the URL of the funding.json manifest do not have the same hostname. Starts with https:// or http://. Max len 250.
28+
},
29+
"repositoryUrl": {
30+
"url": "https://github.com/graphile/worker", // Required. URL of the repository where the project's source code and other assets are available. Starts with https:// or http://. Max len 250.
31+
"wellKnown": "" // Optional. Required if the above url and the URL of the funding.json manifest do not have the same hostname. Starts with https:// or http://. Max len 250.
32+
},
33+
"licenses": ["spdx:MIT"], // Required. The project's licenses (up to 5). For standard licenses, use the license ID from the SDPX index prefixed by "spdx:". eg: "spdx:GPL-3.0", "spdx:CC-BY-SA-4.0"
34+
"tags": [
35+
"developer-tools",
36+
"development",
37+
"programming",
38+
"software-engineering",
39+
"web-development"
40+
] // Required. Up to 10 general tags describing the project. Lowercase-alphanumeric-dashes (max 32 chars). eg: ["programming", "developer-tools"]. For reference, see tags.txt
41+
},
42+
{
43+
"guid": "postgraphile", // Required. A short unique ID for the project. Lowercase-alphanumeric-dashes only. eg: my-cool-project. Max len 32.
44+
"name": "PostGraphile", // Required. Name of the project. Max len 250.
45+
"description": "An incredibly low-effort way to build a well structured and high-performance GraphQL API backed primarily by a PostgreSQL database. Our main focusses are performance, automatic best-practices and customisability/extensibility. Use this if you have a PostgreSQL database and you want to use it as the source of truth for an auto-generated GraphQL API (which you can still make significant changes to).", // Required. Description of the project. Max len 2000.
46+
"webpageUrl": {
47+
"url": "https://postgraphile.org/", // Required. Webpage with information about the project. Starts with https:// or http://. Max len 250.
48+
"wellKnown": "" // Optional. Required if the above url and the URL of the funding.json manifest do not have the same hostname. Starts with https:// or http://. Max len 250.
49+
},
50+
"repositoryUrl": {
51+
"url": "https://github.com/graphile/crystal/tree/main/postgraphile/postgraphile", // Required. URL of the repository where the project's source code and other assets are available. Starts with https:// or http://. Max len 250.
52+
"wellKnown": "" // Optional. Required if the above url and the URL of the funding.json manifest do not have the same hostname. Starts with https:// or http://. Max len 250.
53+
},
54+
"licenses": ["spdx:MIT"], // Required. The project's licenses (up to 5). For standard licenses, use the license ID from the SDPX index prefixed by "spdx:". eg: "spdx:GPL-3.0", "spdx:CC-BY-SA-4.0"
55+
"tags": [
56+
"developer-tools",
57+
"development",
58+
"programming",
59+
"software-engineering",
60+
"web-development"
61+
] // Required. Up to 10 general tags describing the project. Lowercase-alphanumeric-dashes (max 32 chars). eg: ["programming", "developer-tools"]. For reference, see tags.txt
62+
}
63+
],
64+
65+
// Required.
66+
"funding": {
67+
// Required. This describes one or more channels via which the entity can receive funds.
68+
"channels": [
69+
{
70+
"guid": "github-sponsors", // Required. A short unique ID for the channel. Lowercase-alphanumeric-dashes only. eg: mybank, my-paypal. Max len 32.
71+
"type": "payment-provider", // Required. [bank, payment-provider, cheque, cash, other].
72+
"address": "", // Optional. A short unstructured textual representation of the payment address for the channel. eg: "Account: 12345 (branch: ABCX)", "[email protected]", "https://payment-url.com", or a physical address for cheques. Max len 250.
73+
"description": "We prefer GitHub sponsors due to their low fees. Pay by credit card as an individual or organisation." // Optional. Any additional description or instructions for the payment channel. Max len 500.
74+
},
75+
{
76+
"guid": "bespoke", // Required. A short unique ID for the channel. Lowercase-alphanumeric-dashes only. eg: mybank, my-paypal. Max len 32.
77+
"type": "bank", // Required. [bank, payment-provider, cheque, cash, other].
78+
"address": "", // Optional. A short unstructured textual representation of the payment address for the channel. eg: "Account: 12345 (branch: ABCX)", "[email protected]", "https://payment-url.com", or a physical address for cheques. Max len 250.
79+
"description": "Bespoke invoicing arrangements for larger sponsor amounts (USD 1500 or above). Please get in touch." // Optional. Any additional description or instructions for the payment channel. Max len 500.
80+
}
81+
],
82+
83+
// Required. One or more funding and payment plans.
84+
"plans": [
85+
{
86+
"guid": "production", // Required. A short unique ID for the plan. Lowercase-alphanumeric-dashes only. eg: mybank, paypal. Max len 32.
87+
"status": "active", // Required. [active, inactive]. Indicates whether this plan is currently active or inactive.
88+
"name": "Production Sponsor", // Required. Name of the funding plan. eg: "Starter support plan", "Infra hosting", "Monthly funding plan".
89+
"description": "Access to private security announcements. Free access to @graphile/pro. Your avatar featured on our website, plus benefits of lower tiers", // Optional. Any additional description or instructions for the funding plan.
90+
"amount": 100, // Required. The solicited amount for this plan. 0 is a wildcard that indicates "any amount".
91+
"currency": "USD", // Required. Three letter ISO 4217 currency code. eg: USD
92+
"frequency": "monthly", // Required. [one-time, weekly, fortnightly, monthly, yearly, other]
93+
"channels": ["github-sponsors"] // Required. One or more channel IDs defined in channels[] via which this plan can accept payments.
94+
},
95+
{
96+
"guid": "featured", // Required. A short unique ID for the plan. Lowercase-alphanumeric-dashes only. eg: mybank, paypal. Max len 32.
97+
"status": "active", // Required. [active, inactive]. Indicates whether this plan is currently active or inactive.
98+
"name": "Featured Sponsor", // Required. Name of the funding plan. eg: "Starter support plan", "Infra hosting", "Monthly funding plan".
99+
"description": "Your name and avatar featured in the READMEs of Graphile projects, plus benefits of lower tiers", // Optional. Any additional description or instructions for the funding plan.
100+
"amount": 500, // Required. The solicited amount for this plan. 0 is a wildcard that indicates "any amount".
101+
"currency": "USD", // Required. Three letter ISO 4217 currency code. eg: USD
102+
"frequency": "monthly", // Required. [one-time, weekly, fortnightly, monthly, yearly, other]
103+
"channels": ["github-sponsors"] // Required. One or more channel IDs defined in channels[] via which this plan can accept payments.
104+
},
105+
{
106+
"guid": "advisor", // Required. A short unique ID for the plan. Lowercase-alphanumeric-dashes only. eg: mybank, paypal. Max len 32.
107+
"status": "active", // Required. [active, inactive]. Indicates whether this plan is currently active or inactive.
108+
"name": "Private Advisor", // Required. Name of the funding plan. eg: "Starter support plan", "Infra hosting", "Monthly funding plan".
109+
"description": "A complementary support contract is offered (more detail on request), plus benefits of lower tiers", // Optional. Any additional description or instructions for the funding plan.
110+
"amount": 1500, // Required. The solicited amount for this plan. 0 is a wildcard that indicates "any amount".
111+
"currency": "USD", // Required. Three letter ISO 4217 currency code. eg: USD
112+
"frequency": "monthly", // Required. [one-time, weekly, fortnightly, monthly, yearly, other]
113+
"channels": ["github-sponsors"] // Required. One or more channel IDs defined in channels[] via which this plan can accept payments.
114+
},
115+
{
116+
"guid": "bespoke-advisor", // Required. A short unique ID for the plan. Lowercase-alphanumeric-dashes only. eg: mybank, paypal. Max len 32.
117+
"status": "active", // Required. [active, inactive]. Indicates whether this plan is currently active or inactive.
118+
"name": "Private Advisor", // Required. Name of the funding plan. eg: "Starter support plan", "Infra hosting", "Monthly funding plan".
119+
"description": "A complementary support contract is offered (more detail on request), plus benefits of lower tiers", // Optional. Any additional description or instructions for the funding plan.
120+
"amount": 4500, // Required. The solicited amount for this plan. 0 is a wildcard that indicates "any amount".
121+
"currency": "USD", // Required. Three letter ISO 4217 currency code. eg: USD
122+
"frequency": "quarterly", // Required. [one-time, weekly, fortnightly, monthly, yearly, other]
123+
"channels": ["bespoke"] // Required. One or more channel IDs defined in channels[] via which this plan can accept payments.
124+
},
125+
{
126+
"guid": "bespoke", // Required. A short unique ID for the plan. Lowercase-alphanumeric-dashes only. eg: mybank, paypal. Max len 32.
127+
"status": "active", // Required. [active, inactive]. Indicates whether this plan is currently active or inactive.
128+
"name": "Bespoke Agreement", // Required. Name of the funding plan. eg: "Starter support plan", "Infra hosting", "Monthly funding plan".
129+
"description": "A complementary support or consultancy contract can be offered (more detail on request), plus benefits of lower tiers", // Optional. Any additional description or instructions for the funding plan.
130+
"amount": 0, // Required. The solicited amount for this plan. 0 is a wildcard that indicates "any amount".
131+
"currency": "USD", // Required. Three letter ISO 4217 currency code. eg: USD
132+
"frequency": "other", // Required. [one-time, weekly, fortnightly, monthly, yearly, other]
133+
"channels": ["bespoke"] // Required. One or more channel IDs defined in channels[] via which this plan can accept payments.
134+
}
135+
],
136+
137+
// Optional. A simple summary of funding history. Only include if at least one, either income or expenses, have to be communicated.
138+
"history": [
139+
{
140+
"year": 2024, // Required. Year (fiscal, preferably).
141+
"income": 0, // Optional.
142+
"expenses": 0, // Optional.
143+
"taxes": 0, // Optional.
144+
"currency": "", // Required. Three letter ISO 4217 currency code. eg: USD
145+
"description": "" // Optional. Any additional description. Max length 500.
146+
}
147+
]
148+
}
149+
}

0 commit comments

Comments
 (0)