From b1a066130dc28967df7103fe4b53de75c29dc57b Mon Sep 17 00:00:00 2001 From: edwin kiyimba Date: Tue, 4 Feb 2025 09:29:52 +0300 Subject: [PATCH 1/3] Added contibution guidlines --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b9d4f72..d92affb4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,39 @@ We love your input! We want to make contributing to this project as easy and tra - Proposing new features - Becoming a maintainer +## Setting up locally with venv +Create virtual environment +```sh +python -m venv .venv +``` +Switch to the virtual environment +```sh +source .venv/bin/activate +``` +- For windows run: +```sh +.venv/Scripts/activate +``` +Install Requirements +```sh +pip install dev.requirements.txt +``` +Create a `secrets.py` file in the `pyconafrica` folder + - This will hold all the environment variables +Run migrations +```sh +python manage.py migrate +``` +Create a superuser account +```sh +python manage.py createsuperuser +``` +Run the server +```sh +python manage.py runserver +``` +Log into the superuser account via [http://localhost/accounts/login] + ## We Develop with Github We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. From 125857560cd49db5fbf1d146f25560af771b1f93 Mon Sep 17 00:00:00 2001 From: edwin kiyimba Date: Tue, 4 Feb 2025 09:32:48 +0300 Subject: [PATCH 2/3] Added step to add an event year --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d92affb4..65fc0c60 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,9 @@ Run the server ```sh python manage.py runserver ``` -Log into the superuser account via [http://localhost/accounts/login] +Log into the superuser account [http://localhost/accounts/login] +Access the admin dashboard [http://127.0.0.1:8000/organizers/] +Add an event year [] ## We Develop with Github We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. From f5eab614a5b947b48ca98584ccbfd66178232fc1 Mon Sep 17 00:00:00 2001 From: edwin kiyimba Date: Tue, 4 Feb 2025 09:34:17 +0300 Subject: [PATCH 3/3] Update contributing guidelines to include link for adding an event year --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65fc0c60..dfdda27d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,7 +40,7 @@ python manage.py runserver ``` Log into the superuser account [http://localhost/accounts/login] Access the admin dashboard [http://127.0.0.1:8000/organizers/] -Add an event year [] +Add an event year [http://127.0.0.1:8000/organizers/home/eventyear/] ## We Develop with Github We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.