Welcome to giteo’s documentation!¶
Giteo¶
About¶
Giteo is a CLI-based URL shortener written in Python which uses GitHub’s git.io URL shortening service.
Getting Started¶
These instructions will get you a copy of the project up and running on your local machine.
Prerequisites¶
Python 3.7+
Pipenv
Docker (Optional)
Development Setup¶
Fork this repo
Set up your Pipenv environment (
pipenv install
)Set up your Docker environment (
docker build -t giteo:latest .
) (Optional)