devedmonton / DES-Website

The Dev Edmonton Society website! We empower Edmonton Developers!
https://devedmonton.com
MIT License
29 stars 78 forks source link

Added contributors endpoint for github #441

Open dgmouris opened 3 weeks ago

dgmouris commented 3 weeks ago

What issue is this referencing?

https://github.com/devedmonton/DES-Website/issues/323

This PR essentially approaches the backend part of the contributors.

The only thing that we're going to need here is to put the Github API key as an environment variable for this to work.

Once this is merged (a little like the calendar) it'll be open season to create the page.

I really appreciate any reviews, and I hope this helps:)

Do these code changes work locally and have you tested that they fix the issue yourself?

Does the following command run without warnings or errors?

Have you taken a look at our contributing guidelines?

My node version matches the one suggested when running nvm use?

arashsheyda commented 3 weeks ago

also if we add .get or .post or ... to the file name, that would be the only supported method for that endpoint e.g. contributors.get.js

and if we used TS and defined the returned type, we automatically get them in the frontend of Nuxt

but do you think it's a good idea or that would be confusing for others?

dgmouris commented 3 weeks ago

also if we add .get or .post or ... to the file name, that would be the only supported method for that endpoint e.g. contributors.get.js

I agree here that is a good idea. I'll whip this up shortly.

Let me take a bit of a gander at the TS piece.

arashsheyda commented 3 weeks ago

thanks!

dgmouris commented 1 week ago

An important note about this pull request.

You'll need to include the GitHub API KEY as an environment variable this can be found under:

Just a note here we might have to refresh it somehow or make it not expire but I don't know if that's an option.