EddieHubCommunity / RepoRater

Rate GitHub Repos for Developer Experience (DX)
https://repo-rater.eddiehub.org
MIT License
151 stars 37 forks source link

[DOCS] Add string size values and instructions on API key creation #70

Closed j-grosse closed 8 months ago

j-grosse commented 8 months ago

Is this a unique feature?

Is your feature request related to a problem/unavailable functionality? Please describe.

1. When creating collection attributes, Appwrite requires you to specify the character size for the attributes of type string.

2. As also discussed with Eddie it would help to add instructions on how to find the button to create the API key in Appwrite.

Proposed Solution

1. add the values that Eddie gave me via discord in bullet points 4 and 5:

repos collection strings... description: 1024 name: 128 (required) owner: 128 logo: 512

ratings collection strings... username: 128

2. add to quickstart instructions under bullet point number 7. (in brackets):

Get you private keys from Appwrite (Overview > Integrations > "API Keys" tab > "+ Create API key" button) and add them to .env template (all data are required).

Screenshots

by default 2024-01-01 at 20 51 12

Do you want to work on this issue?

Yes

If "yes" to above, please explain how you would technically implement this

add text in Readme.md, see screenshot

j-grosse commented 8 months ago

I could also change the api example calls in the docs from eddiehub.org to eddiehub.io as they are not working: https://github.com/EddieHubCommunity/RepoRater?tab=readme-ov-file#api-3rd-party-apps

eddiejaoude commented 8 months ago

Sorry for the delay, I have assigned it to you.

I could also change the api example calls in the docs from eddiehub.org to eddiehub.io as they are not working: https://github.com/EddieHubCommunity/RepoRater?tab=readme-ov-file#github-action

Good spot, yes please 👍

j-grosse commented 8 months ago

Sorry for the delay, I have assigned it to you.

I could also change the api example calls in the docs from eddiehub.org to eddiehub.io as they are not working: https://github.com/EddieHubCommunity/RepoRater?tab=readme-ov-file#github-action

Good spot, yes please 👍

OK, I created a new issue for that: https://github.com/EddieHubCommunity/RepoRater/issues/79