virtualcoffee.io
virtualcoffee.io copied to clipboard
Add your profile to our Members Page!
The best part of Virtual Coffee is our members ❤️
In order to showcase our collective awesomeness, let's put together a members page!
Members will individually add their GitHub username. At build time, we'll pull down their GitHub profile and display their info on a page located at /members.
This is the first iteration of this feature, so we'll add features to it as we go.
Note - only PRs from existing Virtual Coffee members will be accepted
Attending one of our Virtual Coffee events is the best way to learn how to become a member.
Adding yourself to the members page:
GitHub Profile Information
Members can edit their GitHub profile at https://github.com/settings/profile
virtualcoffee.io will only ever have access to the public profile information, never anything private.
Info we'll use to build the members page:
- Name
- Profile Picture
- URL
- Bio
- Twitter Username
Before you submit a PR, take a moment and check out this information to make sure it's accurate and you feel comfortable displaying it on our site!
How to add or update your profile:
The steps below involve your GitHub username. For each of the steps below, replace yourusername
with your actual GitHub username (mine is danieltott
for example).
- Follow these steps to create a fork of this repository and clone it to your local machine.
- Create a branch called
members/yourusername
-
If you're adding your profile for the first time:
- Create a copy of
members/members/_EXAMPLE.ts
and name ityourusername.ts
-
NOTE: for the file name and export name, please remove any dashes in your username. You can replace them with underscores or just remove them entirely. For example, if my username was
virtual-coffee
, we'd want to change that tovirtualcoffee.ts
for the file name, and for the export name in the next step. - Replace
_EXAMPLE
on line 4 with your github username- export const _EXAMPLE: MemberObject = { + export const yourusername: MemberObject = {
- Update the
github
value to your username, and follow the comments in the file to customize any additional parts of your VC profile - Note - if you already have the local version running, you'll need to stop the server and restart it to see the new file.
- Commit the new file
- Create a copy of
-
If you're already on the page but would like to update your profile:
- Find
members/members/yourusername.ts
- Inside you will find the file all set up, follow the comments in the file to update any data you'd like
- Commit the modified file
- Find
- Push your branch up to your fork
- Create a Pull Request and link to this issue
At this point, the pull request will create a Deploy Preview that you can use to preview your changes.
If you'd like to try updating the data on your own, here are the steps you can follow, but it's not required.
- To test locally, follow the Local Development steps listed in our README
- After the site is installed, you'll need to follow these directions to create a Personal Access Token.
- The token only needs permission for the user => read:user scope to function for this task:
- The token only needs permission for the user => read:user scope to function for this task:
- Once you have your token, create a new file called
.env
and copy the contents from.env.example
. Then, uncomment theGITHUB_TOKEN
line, and replaceyourtoken
with your token created in the previous step. - Then run
yarn start
to preview your changes! - Again, these steps are not required for the PR to be accepted
And you're done!
Our Contributing Guide has a lot of information about getting started with GitHub and Pull Requests, so you might want to take a look at that as well if you are new to this process.
Please feel free to add any questions here in the comments!
Here from VC to start working on this issue!
Just some additional info on the github token if you're regenerating the member data: the token only needs permission for the user => read:user scope to function for this task 👇🏻
Thanks @shiftyp! - I updated the issue description with that ❤️
Hey @danieltott,
To make it smoother for our new members in adding their profile to our member page, we might want give the link to the members/members/_EXAMPLE.ts
.
We can, for example, do:
- If you're adding your profile for the first time:
- Create a copy of members/members/_EXAMPLE.ts and name it
yourusername.ts
- Create a copy of members/members/_EXAMPLE.ts and name it
Thanks @adiati98! Just updated it!
@danieltott @BekahHW FYI, me and @dominicduffin1 found that this issue is closed with the changes in PR #920. We might want to reopen this issue and give clarification not to use closes, fixes, etc. when creating PR to prevent closing this issue.
Thank you! 😄