Pull resource information from GitHub
Closed this issue · 12 comments
Should pull information from the technical part of our resources repo to display:
- The technology
- Description
- Useful links
Should be responsive on both desktop and mobile devices. Design references can be found here.
Updating this to just be pulling the resource above info from GitHub.
Hi, I'm interested in contributing. You mentioned you wanted each technology, its description and its links to be displayed. The link sends me to the ProjectIdeas.md. Should the info on projects be included as well?
Also, by "pull" you mean just "hard-code" all the data? I was looking at GitHub's API and it looks like there is a way to just make calls to get the content of the files.
Oh that was my bad, the correct link is here (the original post should be updated now too).
And by pull I mean when the page loads we'll have JavaScript run to get the information from the files on the resources repo (we can make sure they all have a similar format), parse each file for the title, description, and links, then render that appropriately with HTML on the website. This way we would only need to update the information in the repo and the website should automatically be updated in turn.
In the future we might improve this so it wouldn't need run every time the page loads, but it should be fine for the first iteration.
I can add you to the repo now so you edit it. Be sure to branch off of dev. Also feel free to come to a club meeting where we cover open source technology and work on projects like this! All of our events are on Facebook, we chat on our Slack (including about this project), and you can find more information about the club here.
Awesome! I'll be showing up to meetings :)
Here are some resources for pulling content from GitHub I've found after doing some research.
- Official API - Seems to be kinda annoying by only serving encoded data
- Unofficial Service - This seems like a good alternative if we can't get the official API to play nice
- Other Unofficial Service - If we need another option
- Reading a JavaScript file from another site - I would recommend looking for other examples too
Right now, I'm using both the official github API and the unnoficial one that returns the raw file. The official API lets me grab each file name in that content so then I can just concatenate it to the get raw file api URL instead of just hardcoding each file name. Here is a screenshot of what I have so far. Now it's just a matter of displaying it on the website properly.
Made some progress :)
Just need to not pull the stuff that's not necessary, like the readme.md.
Oh awesome progress! @juansuh is also looking in to this so you two could collaborate on it
I'm using the html for resources page that was already on the github repo.Still trying to figure out how branching works exactly. 😅
If you can make it to a Casual Coding I'd have an easier time explaining it in person, but this is a pretty good article on branching concepts
This functionality is being moved to the club-backend so the information could be retrieved on multiple clients
I'm closing this issue as it was part of the react-conversion of the website and redesign of the backend.