Skip to content
This repository has been archived by the owner on Jul 3, 2021. It is now read-only.

Latest commit

Β 

History

History
70 lines (50 loc) Β· 3.68 KB

README.md

File metadata and controls

70 lines (50 loc) Β· 3.68 KB
Raw

Clubhouse Profile

🌸 Make your own profile from Clubhouse and host it on the web.

This repository uses React & Next.js for the frontend, and to update your profile weekly, Axios(we create the client to communicate with the Clubhouse API), and GitHub Actions(for scheduling updates with cronjob).

πŸ‘‹ Your Clubhouse profile, on the web

Open, Paste, and Follow

βœ… Open the Clubhouse app with the button,
and your nickname gets automatically copied to the clipboard!

πŸš€ Create your own

Follow this tutorial to have your own Clubhouse profile in the web πŸ™Œ

1. Fork this repository on GitHub

You can fork this repository with the branch-like icon placed on the top right. Press that and this repo will be cloned to your GitHub account.

If you liked this project, you can also give me a star anytime! ⭐️

2. Set Actions secrets

Now you should set the environment variables required to fetch/update your profile.

Set the necessary values with each key.

  • You'll need authentication to get the values AUTH_TOKEN and USER_ID(If you don't know yours).
    • I once made a Jupyter Notebook on some other project for this task. You can either use other known clients of Clubhouse or follow other tutorials.
    • If you need help, please leave an issue here, and I'll make some kind of crazy things to go through this task or just help you when I have spare time, or hopefully, the community will help. 😁
  • UUID is just a random UUIDv4 value used to determine devices, so you can generate it here or somewhere else.

You can specify the values in the project root's .env file, and run the command yarn update to update your profile manually in your machine. See the file .env.example for reference.

3. Deploy your app

# Install dependencies
$ yarn

# Build your profile
$ yarn build
  • You can host the output files after the build ends, following the command above.
  • Or you can use cloud platforms like Vercel, Netlify, .etc.
    • I'm a huge fan of Vercel, by the way(disclaimer: sadly, I'm not related to this company, but would like to). It makes me ship my ideas right away for most of the projects I do, saving me a lot of time.
    • One of the good reasons to use them is because they can connect to GitHub repositories. In our case, the Workflow retrieves your profile information every Monday and commits the changes. Vercel or Netlify can reflect the changes to your deployment automatically.

4. Run your workflow

The Workflow is scheduled to run every Monday, UTC 00:00(In Korean time it's 09:00).

In case you want to run the Workflow manually, it has a workflow_dispatch trigger so you can run it in the GitHub Actions tab anytime you want.