Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

grant management webapp milestone1 delivery #970

Merged
merged 2 commits into from
Aug 23, 2023

Conversation

lawmeskiviahs
Copy link
Contributor

@lawmeskiviahs lawmeskiviahs commented Aug 9, 2023

Milestone Delivery Checklist

  • The milestone-delivery-template.md has been copied and updated.
  • The invoice form 📝 has been filled out for this milestone.
  • This pull request is being made by the same account as the accepted application.
  • I have disclosed any and all sources of reused code in the submitted repositories and have done my due diligence to meet its license requirements.
  • In case of acceptance, the payment will be transferred to the BTC/ETH/fiat account provided in the application.
  • The delivery is according to the Guidelines for Milestone Deliverables.

Link to the application pull request: w3f/Grants-Program#1766

@lawmeskiviahs lawmeskiviahs reopened this Aug 10, 2023
@dsm-w3f dsm-w3f self-assigned this Aug 11, 2023
@dsm-w3f
Copy link
Contributor

dsm-w3f commented Aug 11, 2023

@lawmeskiviahs thank you for the milestone delivery. Please see the evaluation document and provide proper answers and fixes. Let me know when I can continue the evaluation.

@lawmeskiviahs
Copy link
Contributor Author

lawmeskiviahs commented Aug 17, 2023

@dsm-w3f Thankyou for your evaluation. We have made some changes to the repository. You may continue the evaluation on the master branch of the repository. Updates have been made to the documentation. I hope you'll find everything you need in the docs :D

Environment Variables Setup Guide

This guide will help you set up your development environment for testing the code using docker-compose. We'll be using the env.example file provided in the root directory of the backend repository to configure the required environment variables.

Step 1: Clone the Repository

  1. Take a fresh clone of the master branch of the backend repository

Step 2: Copy and Configure the Environment Variables

  1. Locate the env.example file in the repository's root directory.
  2. Create a copy of env.example in /src/config and name it prod.env.

Step 3: Fill in the Environment Variables

Open the prod.env file in a text editor of your choice and fill in the following environment variables:

General configuration

Env name Default value Possible values Description
PORT 7001 any port number The port number on which your application will listen
DBNAME myappdb any string value The name of the database you'll be using
REDIS_URL redis://localhost:6379 any string value The connection URL for your Redis server.
MONGO_URI mongodb://localhost:27017 any string value The connection URI for your MongoDB database

Github configurations

Env name Default value Possible values Description
GITHUB_CLIENT_ID - provided by github The client ID for your GitHub OAuth application. To get this, first register an OAuth App.
GITHUB_CLIENT_SECRET - provided by github The client secret for your GitHub OAuth application. Can be found in settings once and OAuth app is registered.
GITHUB_REDIRECT_URI - provided by github The redirect URI for your GitHub OAuth application. This Guide will help you in locating this in your OAuth app settings.
APPLICATIONS_REPO '/repos/w3f/Grants-Program/contents/applications' link to the application folder of any grants repo URL to the folder containing application MD files
DELIVERIES_REPO '/repos/w3f/Grant-Milestone-Delivery/contents/deliveries' link to the deliveries folder of any grants repo URL to the folder containing delivery MD files
GITHUB_PULL_REQUEST_URL https://github.com/w3f/Grants-Program link to the any grants repo URL for getting data for Pull Requests
GIT_USER_DETAILS_URL https://api.github.com/user - URL for getting user details
GITHUB_ACCESS_TOKEN_CLASSIC - any valid github Personal Access Token Access token for GitHub API
GITHUB_VERIFY_ACCESS_TOKEN_URL https://github.com/login/oauth/access_token - URL to check the validity of the access token

Step 4: Save and Run

  1. Save the changes to the prod.env file.
  2. Run the application using: docker-compise up -d
  3. The application should now use the configured environment variables.

Step 5: Test

  1. Locate the env.example file in the repository's root directory.
  2. Create a copy of env.example in /src/config and name it test.env.

This guide has also been added to the documentation of the repository. If you encounter issues or need further assistance, please feel free to write to me at [email protected] If the need be we could get into a video call and help you setup the environment.

@lawmeskiviahs
Copy link
Contributor Author

pinging @dsm-w3f

@dsm-w3f
Copy link
Contributor

dsm-w3f commented Aug 21, 2023

@lawmeskiviahs thank you for the improvements and fixes. I checked again and now I was able to run the application. It works, however there are some doubts and improvement suggestions. Please see the evaluation document for details. Let me know when I can continue this evaluation.

@lawmeskiviahs
Copy link
Contributor Author

lawmeskiviahs commented Aug 22, 2023

Thank you @dsm-w3f evaluating the delivery again. The changes you suggested have been done. Please continue with your evaluation.
Regarding the pointers that you mentioned in the evaluation document:

  1. We've opted for shortened project names on the front-end for a cleaner and organised look. Some longer project names take up to three lines in the table, which doesn't appear very neat. This can be changed if you want.
  2. Filter on basis of date has been implemented. Regarding the cost, we're using different crypto forms for various grants, and sorting based on value will take some additional effort. We could consider adding this in the next milestone.
  3. The proposals (applications) are part of the next milestone. The button you are referring to will also work by the time we are finished developing the next milestone. Meanwhile we have added a 'coming soon' screen to it.
  4. The merge and status changes are only in the database and don't reflect on GitHub. We can do something about this in the second milestone.
  5. Application mentioned in the web-app are proposals to the grants program (Proposal Pull Requests). Whereas projects are the applications that got accepted and now are being worked upon.
  6. Borders have been added to all tables in the web app.

@dsm-w3f
Copy link
Contributor

dsm-w3f commented Aug 23, 2023

@lawmeskiviahs thank you for the improvements and fixes. I tested again and most of my comments were fixed/improved. Please see the evaluation document for details. The milestone is accepted. I'll forward your invoice internally and the payment should take place within two weeks. Great job!

Just a final comment. I think the application is becoming good and with minor adjustments could be possible to try to use it in practice. I'll try to gather more feedback from other members of the grants team. We can try to discuss possible improvements in your next grant application, if you plan to do it.

@dsm-w3f dsm-w3f merged commit 0d1beb4 into w3f:master Aug 23, 2023
1 check passed
@github-actions
Copy link

We noticed that this is the last milestone of your project. Congratulations on completing your grant! 🎊

So, where to from here? First of all, you should join our Grants Community chat, if you haven't already, so we can stay in touch.
If you are looking for continuative support for your project, there are quite a few options. The main goal of the W3F grants program is to support research as well as early-stage technical projects. If your project still falls under one of those categories, you might want to apply for a follow-up grant. However, depending on your goals and project status, there are other support programs in our ecosystem that might be better suited as the next step. For example, projects with a Business Case/Token should look into the Substrate Builders Program or VC Funding. Common Good projects have a good chance of receiving Treasury Funding.

For a more comprehensive list, see our Alternative Funding page. Let us know if you have any questions regarding the above. We are more than happy to point you to additional resources and help you determine the best course of action.
Lastly, we hope your W3F grant was a success and we want to thank you for being part of the journey!

@semuelle
Copy link
Member

@lawmeskiviahs, I noticed that your grant application lists DOT as payment, which we don't support. You can choose USDT payment on Polkadot Asset Hub. Can you please submit an amendment to provide a different currency and/or payment method as per our application process description? Also, the invoice only lists fiat payment details. If you want to be paid in cryptocurrency, please add the payment address to the invoice.

@lawmeskiviahs
Copy link
Contributor Author

lawmeskiviahs commented Aug 28, 2023

Thankyou @semuelle for your observation. In the default delivery message above I have mentioned that the payment address is not the same as the one in the application. Could you please follow the invoice for details on the payment?

@semuelle
Copy link
Member

I don't see a comment in that regard. But if you would like to change the payment details, could you submit an amendment to the grant document? It's simple and usually quickly approved; we just want to make sure there is a "paper trail" in case there are questions later.

@lawmeskiviahs
Copy link
Contributor Author

Hi @semuelle thanks for merging the CR. Are we good to go now?

@semuelle
Copy link
Member

semuelle commented Sep 1, 2023

Hey @lawmeskiviahs. We are good to go. It might still take a week for the invoice to be processed. But do let me know if you haven't heard back in a week.

@lawmeskiviahs lawmeskiviahs deleted the gmw_milestone_1 branch September 7, 2023 10:08
@lawmeskiviahs
Copy link
Contributor Author

@semuelle any updates on the payment?

@RouvenP
Copy link

RouvenP commented Sep 8, 2023

hi @lawmeskiviahs we transferred the payment on 1st September. Could you check again whether you received it? If not, we will get in touch with our bank to investigate

@lawmeskiviahs
Copy link
Contributor Author

Could you send the transaction details, Maybe the receipt or account details from where the payment was made, we will be able to verify the payment using that.

@lawmeskiviahs
Copy link
Contributor Author

Hi @RouvenP. We have recieved the payment. Thank-you so much

@RouvenP
Copy link

RouvenP commented Sep 8, 2023

great, thanks for the update @lawmeskiviahs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants