diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aff8c8f..cc3292a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,9 @@ * Install the Ballot app on the new site `bench --site test.ballot install-app ballot` * [Access the site conveniently](https://frappeframework.com/docs/user/en/tutorial/create-a-site#access-site-in-your-browser) from your computer using `bench --site test.ballot add-to-hosts` +* Add `"ignore_csrf":1` to the `sites/common_site_config.json` + configuration file. Without this, performing operating on the frontend app + raises CSRF errors * Finally, run `bench start` to launch the backend The frappe framework-powered backend application should now be running. To run diff --git a/docs/docs/assets/add-team-member.png b/docs/docs/assets/add-team-member.png new file mode 100644 index 0000000..4119431 Binary files /dev/null and b/docs/docs/assets/add-team-member.png differ diff --git a/docs/docs/assets/all-elections.png b/docs/docs/assets/all-elections.png new file mode 100644 index 0000000..c6bff28 Binary files /dev/null and b/docs/docs/assets/all-elections.png differ diff --git a/docs/docs/assets/apply-for-candidature.png b/docs/docs/assets/apply-for-candidature.png new file mode 100644 index 0000000..543d4fb Binary files /dev/null and b/docs/docs/assets/apply-for-candidature.png differ diff --git a/docs/docs/assets/candidature-submissions.png b/docs/docs/assets/candidature-submissions.png new file mode 100644 index 0000000..31179ff Binary files /dev/null and b/docs/docs/assets/candidature-submissions.png differ diff --git a/docs/docs/assets/create-candidate-form.png b/docs/docs/assets/create-candidate-form.png new file mode 100644 index 0000000..bfe3ffc Binary files /dev/null and b/docs/docs/assets/create-candidate-form.png differ diff --git a/docs/docs/assets/create-new-election.png b/docs/docs/assets/create-new-election.png new file mode 100644 index 0000000..55ab18e Binary files /dev/null and b/docs/docs/assets/create-new-election.png differ diff --git a/docs/docs/assets/create-team.png b/docs/docs/assets/create-team.png new file mode 100644 index 0000000..ec9d206 Binary files /dev/null and b/docs/docs/assets/create-team.png differ diff --git a/docs/docs/assets/edit-candidate-form.png b/docs/docs/assets/edit-candidate-form.png new file mode 100644 index 0000000..022c504 Binary files /dev/null and b/docs/docs/assets/edit-candidate-form.png differ diff --git a/docs/docs/assets/election-candidates.png b/docs/docs/assets/election-candidates.png new file mode 100644 index 0000000..af05cc4 Binary files /dev/null and b/docs/docs/assets/election-candidates.png differ diff --git a/docs/docs/assets/election-live.png b/docs/docs/assets/election-live.png new file mode 100644 index 0000000..23e25fe Binary files /dev/null and b/docs/docs/assets/election-live.png differ diff --git a/docs/docs/assets/elections-details.png b/docs/docs/assets/elections-details.png new file mode 100644 index 0000000..4aafbd0 Binary files /dev/null and b/docs/docs/assets/elections-details.png differ diff --git a/docs/docs/assets/manage-candidates-updated.png b/docs/docs/assets/manage-candidates-updated.png new file mode 100644 index 0000000..93abc78 Binary files /dev/null and b/docs/docs/assets/manage-candidates-updated.png differ diff --git a/docs/docs/assets/manage-candidates.png b/docs/docs/assets/manage-candidates.png new file mode 100644 index 0000000..4c151e9 Binary files /dev/null and b/docs/docs/assets/manage-candidates.png differ diff --git a/docs/docs/assets/new-team.png b/docs/docs/assets/new-team.png new file mode 100644 index 0000000..c8e8366 Binary files /dev/null and b/docs/docs/assets/new-team.png differ diff --git a/docs/docs/assets/select-live-election.png b/docs/docs/assets/select-live-election.png new file mode 100644 index 0000000..297451d Binary files /dev/null and b/docs/docs/assets/select-live-election.png differ diff --git a/docs/docs/assets/submit-comment-candidature-form.png b/docs/docs/assets/submit-comment-candidature-form.png new file mode 100644 index 0000000..e96320d Binary files /dev/null and b/docs/docs/assets/submit-comment-candidature-form.png differ diff --git a/docs/docs/assets/submitted-nomination.png b/docs/docs/assets/submitted-nomination.png new file mode 100644 index 0000000..3cd6cb5 Binary files /dev/null and b/docs/docs/assets/submitted-nomination.png differ diff --git a/docs/docs/assets/team-details.png b/docs/docs/assets/team-details.png new file mode 100644 index 0000000..8ba82ca Binary files /dev/null and b/docs/docs/assets/team-details.png differ diff --git a/docs/docs/assets/team-elections.png b/docs/docs/assets/team-elections.png new file mode 100644 index 0000000..f205924 Binary files /dev/null and b/docs/docs/assets/team-elections.png differ diff --git a/docs/docs/assets/team-updated.png b/docs/docs/assets/team-updated.png new file mode 100644 index 0000000..a123127 Binary files /dev/null and b/docs/docs/assets/team-updated.png differ diff --git a/docs/docs/assets/workspace.png b/docs/docs/assets/workspace.png new file mode 100644 index 0000000..4179d6b Binary files /dev/null and b/docs/docs/assets/workspace.png differ diff --git a/docs/docs/candidature.md b/docs/docs/candidature.md index ef4ea78..62e0784 100644 --- a/docs/docs/candidature.md +++ b/docs/docs/candidature.md @@ -1 +1,41 @@ # Standing for election + +* As a member of the Community, "All Elections" is where you will find + inforamtion about active Elections within the Community + +![All Elections](./assets/all-elections.png) + +## Submit your Candidature form + +* You can select one of the listed Elections to look at additional information + about it and to submit your Candidature form + +![Election information](./assets/select-live-election.png) + +* Please provide all requested information and click on the "Submit" button + +![Apply for candidature](./assets/apply-for-candidature.png) + +* Your Candidature form submissions are visible under the "My Submissions" page + +![Candidate submissions](./assets/candidature-submissions.png) + +## Seeking nominations from the Community + +![Candidates](./assets/select-live-election.png) + +* The list of Candidates who have successfully submitted a Candidature form + for an Election can be found on the Election page + +![Submit nomination](./assets/submit-comment-candidature-form.png) + +* Members of the Community can voluntarily or by request comment on a Candidate + and nominate them. Nominations from esteemed and/or active members of the + Community lend credibility to the Candidate, especially for members of the + Community who might not be regularly active or if they are unaware of the + Candidate + +![Submitted nominations](./assets/submitted-nomination.png) + +* Nominations submitted by the members of the Community are displayed in the + same page diff --git a/docs/docs/organizing.md b/docs/docs/organizing.md index d81e17a..5f6e5ad 100644 --- a/docs/docs/organizing.md +++ b/docs/docs/organizing.md @@ -1 +1,78 @@ # Organizing an election + +![Dashboard](./assets/workspace.png) + +The landing page for Ballot provides easy access to + +* the Dashboard, which provides access to the Teams +* the Submissions page, which contains information about my Candidature + submissions +* the All Elections page, which displays information about all of the "Live" + Elections + +## Creating a team + +* Before you organize an Election, you first need to create a Team. You can + create a Team by clicking on the "Create Team" button on the Dashboard page + and providing a name. + +|Create a Team|Updated Dashboard| +|---|---| +|![Create Team](./assets/create-team.png)|![New team](./assets/new-team.png)| + +* Once a Team is created, Members can be added to the team by clicking on the + "Add Member" button and providing an email address of a User registered on + the Platform + +|Team details|Add a Team member|Updated team details| +|---|---|---| +|![Team details](./assets/team-details.png)|![Add team member](./assets/add-team-member.png)|![Updated team](./assets/team-updated.png)| + +## Creating an Election + +![Team elections](./assets/team-elections.png) + +* Once a "Team" has been created, all Elections for the Team can be viewed under + the "Elections" page. A new Election can be created by clicking on the + "Create Election" button and providing a Title for the election. + +|Create new Election|Updated Elections page| +|---|---| +|![Create new election](./assets/create-new-election.png)|![Election details](./assets/elections-details.png)| + +* Once created, the Election should be displayed in the Elections page. By + default, the Election isn't "live". To make it "live", please click on the + Election and update the "Status" under "Details" to "Live", provide a + "Slug", and update the Description of the Election. + +![Election status](./assets/election-live.png) + +## Creating a Candidature Form + +![Election candidates](./assets/election-candidates.png) + +* Members of the Community who are interested in running for Election should + submit a Candidature Form. The Candidature Form can be created by clicking + on "Create Form" under the "Candidates" section of the Election + +![Create candidate form](./assets/create-candidate-form.png) + +* The Candidate Form can be customized according to the needs of the Community + e.g. the layout of the forum and the questions in the forum can be + customized when creating the Candidature Form. + +![Edit candidate form](./assets/edit-candidate-form.png) + +* The Candidature Form needs to made "Live" by clicking on "Update Form" + and updating the Status to "Live". The "Description" for the Candidature + Form can also be updated here + +## Manage Candidates + +* Once created, members of the Community can express their interest in running + for Election by submitting information via the Candidature Form. Information + about submissions can be viewed in the "Candidates" page for the Election. + +|Candidates with no submissions|Candidates page with a submission| +|---|---| +|![Manage candidates](./assets/manage-candidates.png)|![Manage candidates updated](./assets/manage-candidates-updated.png)|