diff --git a/README.md b/README.md index d9113c03d..701b2fc2d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ --- -ImpactQL is a GraphQL server, that enables rapid development of serverless impact project applications. It does this by taking care of the persistance of impact project data. +ImpactQL is a GraphQL server, that enables rapid development of serverless impact project applications. It does this by taking care of the persistence of impact project data. [Installation](#installation) @@ -31,7 +31,7 @@ cd impact-graph // we specified version in .nvmrc file, so when you just enter nvm use it will use exact version of required npm nvm use -// You should have installed chromium on your system, it can be installed by your or package maneger (apt,brew, ..) +// You should have installed chromium on your system, it can be installed by you or a package manager (apt, brew, ...) npm i // If you had problem on npm install, you can see https://stackoverflow.com/a/66044814/9372962 (Mac os users) cp config/example.env config/development.env @@ -91,7 +91,7 @@ If this is more important you and your have the resources, deploy your own versi ## Architecture -The aim is to give a single entry point into any persistance solution that you want to use for your data. +The aim is to give a single entry point into any persistence solution that you want to use for your data. The aim is for something like this: ![Impact Graph architecture](/docs/img/impact-graph.png) @@ -129,7 +129,7 @@ in your local database you can hash a desired password with `BCRYPT_SALT` that i change `role` of user to `admin` in db Now you can login in admin dashboard with your user's `email` and the `password` you already set -We wrote a migration file to create an admin user in local DB to can test it easily, +We wrote a migration file to create an admin user in local DB to test it easily, so after executing migrations and run application you can navigate to http://localhost:4000/admin and login with this data @@ -139,7 +139,7 @@ with this data - operator role: \*`username`: **operator@giveth.io**, `password`: **admin** **PS**: -A simple script for create encryptedPassword +A simple script for creating encryptedPassword ``` const bcrypt = require('bcrypt'); @@ -229,7 +229,7 @@ https://www.tablesgenerator.com/markdown_tables **PS** - If a project is **cancelled** just admin can activate that -- If project is **deactive** both admins and project owner can activate it +- If project is **deactivated** both admins and project owner can activate it - Both admins and project owner can deactivate an **active** project ### Diagrams diff --git a/docs/campaignsInstruction.md b/docs/campaignsInstruction.md index 1c4f89073..2506c348e 100644 --- a/docs/campaignsInstruction.md +++ b/docs/campaignsInstruction.md @@ -7,13 +7,13 @@ * `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 + * `SortField`: Sometimes in a campaign we just want to show projects in a 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 + * `FilterFields`: Sometimes we need to filter some projects in a campaign, for instance **Let's choose 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 Active`:**Optional**, if you check it, it will 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 @@ -21,8 +21,8 @@ * `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 +* `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 video'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 descending +* `Landing Link`: **Optional**, Sometime we want to redirect user to an external link when click on **Explore** 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 diff --git a/docs/powerBoosting.md b/docs/powerBoosting.md index f8e9c29c1..d7685d1a5 100644 --- a/docs/powerBoosting.md +++ b/docs/powerBoosting.md @@ -119,7 +119,7 @@ the givPower balance of users in each snapshot in order to determine **totalPowe We check with this cronjob expression `FILL_POWER_SNAPSHOT_BALANCE_CRONJOB_EXPRESSION` that in Staging ENV is `20 */5 * * * *` -means every **5 min** to fill power balance , for users that boosted a project in a snapshot but their corresponding balance at the time of the snapshot is not filled. +means every **5 min** to fill power balance, for users that boosted a project in a snapshot but their corresponding balance at the time of the snapshot is not filled. How we fill the balance? We already have filled the **blockNumber** in powerSnapshot so we call the subgraph and ask user's balance in that specific block @@ -266,7 +266,7 @@ https://github.com/Giveth/giveth-dapps-v2/issues/1839 ### What we do if a project that has some boosting got unverified? When we want to create record for **power_boosting_snapshot** we dont save boostings on unverified projects, so when we -verify the project again from next snapshot we start to count them , so in the period that project was unverified +verify the project again from next snapshot we start to count them, so in the period that project was unverified we haven't saved any power_boosting_snapshot for that project but immediately after it gets verified we start to save power_boosting_snapshot for next round