GitHub User Dashboard - Dummy Project

This dummy project is to allow users to view their GitHub profile in more detail and update details. The application uses the design system implemented in Python and Flask and uses the GitHub API.

See documentation here.

Setup

For setting up this project, run the below command. pyenv is a Python version management tool that allows switching between multiple Python versions. jq is a JSON preprocessor that is used to fetch the design system's templates using scripts/load_release.sh.

brew install pyenv jq

Install Python and initialise the virtual environment as shown below. Note: The Python version is 3.11.

pyenv install
python3 -m venv env && source env/bin/activate

Install Poetry, a dependency management and packaging tool, as shown below.

pip install poetry

All the libraries declared are available in pyproject.toml.

To install these dependencies, run make install.

To install these dependencies plus linting and formatting tools, run make install-dev.

Adding your Token

Login to GitHub.

Go to github.com/settings.

Generate new token and enable these repository permissions.

Note: The token must have these scopes and access for the app to work.

Scope	Access
Administration	Read and write

Generate new token and enable these account permissions.

Note: The token must have these scopes and access for the app to work.

Scope	Access
Followers	Read-only
Profile	Read and write
Starring	Read and write

Once you have your token it should look something like this: github_pat_X_LONG_STRING

You can now add this to your environment by using the command:

make add token=<your_token>

If that doesn't work, try this:

export GITHUB_TOKEN=<your_token>

Now you can run your application.

Running the Application

To run the flask application without the debugger active use:

make run

To run the flask application with the debugger active use:

make run-dev

Linting and Formatting

If you have installed the developer dependencies, you are able to lint and format using black, ruff and mypy.

make lint

To clean the temporary files created after running the linter, use make clean.