NOTE: CodeClinics is intended to run on Linux (Works best on Ubuntu)
There are 2 ways to get CodeClinics on your computer, the first method is suggested if you do not intend to change the program at all, the second method being if you want edit the source code to suit your needs better.
Head to the releases tab and download the latest binary (code_clinic)
Fork and clone this repo to your device!
To install dependencies you can run
$ make setup
Or you can use pipenv - Suggested if you are planning to work with this codebase
$ pipenv shell
$ pipenv sync
You can now follow along with the binary users (You will just instead be using python and code_clinic.py)
Open your terminal, your file should be in your downloads so head over to that directory and do the following(this might vary on devices)
$ cd ~/Downloads/
$ chmod +X code_clinic
$ sudo cp code_clinic /usr/local/bin/
You should now be able to run code_clinics, by doing the following
$ code_clinic --help
The output should be similiar to the following
You can then proceed to do the following
$ code_clinic install
You will then see this:
Paste your credentials file (Refer to 2. Google Calendar API) into the storage directory, and press enter (Remember to enable show hidden files)
If you did this step correctly, you will see this:
One of the parts of the installation will also require your google calendar ID (Refer to 2. Google Calendar API if you are unsure what this means)
This program uses the google calendar API and this unfortunately means for any user using this program, they have to familiarize themself with the API to get this prorgram running. This means you need to create a project on the Google Calendar API.
When you have created this project you also need to create an client secret and download the client secret - rename it to 'credentials.json' - and store it in the storage directory.
You can then proceed to create a central calendar that will be used to store all the events in a middle point and go to its settings and find the calendar ID, copy this ID and keep it somewhere for when you install code_clinics.
Use the help command to find out more about how to use this program and have fun.
[No Image] - You can run this command using
$ code_clinic cancel --member-type student