Skip to content
This repository was archived by the owner on Jun 13, 2025. It is now read-only.

campaignsInstruction.md

Latest commit

 

History

History
28 lines (22 loc) · 4.88 KB

campaignsInstruction.md

File metadata and controls

28 lines (22 loc) · 4.88 KB

Campaign Fields

  • title: Required, This is something that we show in frontend like GIVpower is here! text in below image

Screen Shot 1402-01-07 at 12 10 08

  • slug:Required, This should be a string that contains a-z,_,- , 0-9 and please don't use spaces or special characters in that, because we use slug in the link of campaign if we want to go to the campaign link directly

  • type:Required, it can be one of

    • ManuallySelected: In these type of projects we pick some projects to show them in campaign, for instance for Turkey earthquake we pick some projects. so we just need to add slug of those projects in Related Projects Slugs and in what order we add them they will be shown in frontend Screen Shot 1402-01-07 at 12 18 26

    • SortField: Sometimes in a campaign we just want to show projects in an specified order, for instance we can create a campaign like ** Check projects that received most likes** so for this campaign you set SortField as campaign type and then you can use one of below sorting fields Screen Shot 1402-01-07 at 12 26 50

    • FilterFields: Sometimes we need to filter some projects in a campaign, for instance Let's verified projects that accept funds on Gnosis chain, for this we can Add verified and acceptFundOnGnosis filters Screen Shot 1402-01-07 at 12 40 50

    • WithoutProjects: Some campaigns don't include any project in them and they are just some banner like Feeling $nice? campaign in below image Screen Shot 1402-01-07 at 12 43 48

  • Is Active:Optional, if you check it, it would be appear in frontend otherwise it seems you deleted/archived this campaign and users would not see it

  • Is New: Optional, @MohammadPCh Can you help me and tell me what's the usage of this field in frontend?

  • Is Featured:Optional, @MohammadPCh Can you help me and tell me what's the usage of this field in frontend?

  • Description:Required, Write down something about campaign and we show it like Donate eligible tokens to Giveth and receive $nice, redeemable for swag and much more! text in below image Screen Shot 1402-01-07 at 12 52 33

  • Hashtags:Optional, @MohammadPCh I guess frontend doesn't use it anymore, am I right?

  • Related Projects Slugs : It's just Required for campaigns with type ManuallySelected, I already explained it above in type section

  • Photo: Optional, This is the image link that we show in campaign banner, first you need to upload image in pinata and use that link in here, for instance for below campaign this is the value of photo https://giveth.mypinata.cloud/ipfs/QmYR3KLnsRKiibuS5oBRLnyaLM7Sv1QcbBEAPN1DD6d7UP/Nice%20token@2x.png Screen Shot 1402-01-07 at 13 00 39

  • Video:Optional, Some campaigns use video instead of image in banner, like photo first we need to upload it somewhere and then put it here, campaign example Screen Shot 1402-01-07 at 13 08 27

  • Video Preview:Optional, There is an image like above one that we show for video before playing, so if you fill Video it's required to put an image link here to show that as vodeo's preview

  • ‍Order: If you want to show a campaign before others please fill order for it ( we show 1 after that 2, ..) and after those campaigns we show campaigns without orders sorted by created date descanding

  • Landing Link: Optional, Sometime we want to redirect user to an external link when click on Exlore in campaign card, it happens for campaigns that have WithoutProject type because other campaigns usually redirect user to a project list page, in case of you want to redirect to an external link, please fill this field

  • Filter Fields: It's just Required for campaigns with type FilterFields, I already explained it above in type section

  • Sorting Field: It's just Required for campaigns with type SortField, I already explained it above in type section