From 950e6f931e8e1f2e634e07107814314a076644f5 Mon Sep 17 00:00:00 2001 From: Poruri Sai Rahul Date: Tue, 29 Oct 2024 10:36:17 +0530 Subject: [PATCH] DOC: Add a contributing guide the contributing guide include documentation on how to setup the developer environment. The README has also been updated and it includes a link to the CONTRIBUTING guide now --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ README.md | 15 +++++++++++---- 2 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..39cc0b6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +## Setting up the developer environment + +* Ballot is built using the [frappe framework](https://frappeframework.com/docs/user/en/basics) + and a basic understanding of it is necessary to contribute to the codebase +* [Install and setup frappe-bench](https://frappeframework.com/docs/user/en/tutorial/install-and-setup-bench). + We recommend using [pipx](https://github.com/pypa/pipx) to install + `frappe-bench` and updating the `PATH` variable to include the `.../bin/` + folder inside the `pipx`-created Python virtual environment for `frappe-bench` +* Create a new bench with `bench init ballot`. We recommend storing benches + in a single location e.g. `~/frappe-benches` +* CD into the bench directory i.e. `ballot` and clone the Ballot app using + `bench get-app https://github.com/harshtandiya/ballot`. This will clone the + Git repository into the `apps/` folder in the bench directory +* Create a [new site](https://frappeframework.com/docs/user/en/tutorial/create-a-site) + using `bench new-site test.ballot` +* Install the Ballot app on the new site `bench --site test.ballot install-app fossunited` +* [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` +* Finally, run `bench start` and access the site in your browser by navigating + to `http://test.ballot:` diff --git a/README.md b/README.md index fe1b438..d89fb8b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ -## Ballot +# Ballot -E-Voting system based on Frappe +Ballot enables communities to organize elections. -#### License +Built using the Frappe Framework for the FOSS United Platform, Ballot enables +communities to seek candidatures from interested members of the community via +customizable forms. Ballot also enables members of the community to endorse +submissions. In the future, Ballot will also be integrated with a voting +platform where the community can cast votes. -mit +## Contributions + +Please refer to the [contribution guide](./CONTRIBUTING.md) if you are +interested in contributing to the codebase.