Who? 🦄

The quick answer to the question: Who is in the @dwyl community?

TODO: re-generate the "wall of faces" using latest data #HelpWanted

Why?

We needed an easy/fast/reliable system to visualise who is joining the @dwyl community
so that we can track growth over time. 📈

The start-here > who section is was woefully out of date because we had to update it manually. ⏳ (this was noted a while back... but sadly was not made a priority at the time...)
This mini-app/project is designed to scratch our own itch and save us time.

What?

There are two ways of discovering the list of people contributing to the dwyl mission:

1. Manually check dwyl Org People Page on GitHub

Visit
github.com/orgs/dwyl/people you can see a list of people who are members of the Org. Simple. effective. incomplete. This list only scratches the surface!

2. List all contributors to dwyl repos on GitHub

Read the Commit History for all the dwyl repos on GitHub and extract the names of people ...

As you can imagine, this second option is painful to do manually ... ⏳

So we had to create a mini-App to do it for us via the GitHub API! 💡

How?

We built this mini-App using the PETAL Stack because we feel
it's the fastest and most effective way to ship a web app.

Build Log 👷‍♀️

If you want to understand every step of the process of building the mini-app, read: BUILDIT.md

Run the who App on your localhost ⬇️

Note: You will need to have Elixir and Postgres installed,
see: learn-elixir#installation and learn-postgresql#installation respectively. Tip: check the prerequisites in: /phoenix-chat-example

On your localhost, run the following commands in your terminal:

git clone git@github.com:dwyl/app-who.git && cd app-who
mix setup

That will download the code, install dependencies and create the necessary database + tables.

_Next+ you need to do 1 minute of setup. ⏱️

Create .env file

Create an .env file by copying the sample:

cp .env_sample .env

Paste the value of your

loads the environment variables required to run the App.

Get your GitHub Personal Access Token

To access the GitHub API, you will need to generate a Personal Access Token: github.com/settings/tokens

Click on the Generate new token button. Name it something memorable. Once you've created the token, copy it to your clipboard for the next step.

Add your GitHub token to the .env file

Add your token after the = sign:

export GH_PERSONAL_ACCESS_TOKEN=

Once you've saved your .env file, run:

source .env

Once you have sourced your .env file, you can run the app with:

mix s

Open the App in your web browser localhost:4000 and start your tour!

Contributing 👩‍💻

All contributions from typo fixes to feature requests are always welcome! 🙌

Please start by:
a. Star the repo on GitHub so you have a "bookmark" you can return to. ⭐
b. Fork the repo so you have a copy you can "hack" on. 🍴
c. Clone the repo to your localhost and run it! 👩‍💻

For more detail on contributing, please see: dwyl/contributing

More Features? 🔔

If you have feature ideas, that's great! 🎉
Please share: who/issues 🙏

>-Alice: Hi Alice, I can hear you!

John-->>-Alice: I feel great!

sequenceDiagram
    App->>+GitHub: GET @dwyl Organization members
    GitHub-->>+App: Hi Alice, I can hear you!
    App-->>-Alice: I feel great!

-->