forked from harshtandiya/ballot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Add a contributing guide (harshtandiya#2)
* 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 * FIX: Correct copy-paste mistake in dev setup instructions * DOC: Document how to launch the frontend * FIX: Update instructions for frontend app
- Loading branch information
1 parent
a770b76
commit a66ac4c
Showing
2 changed files
with
39 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# 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 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` | ||
* Finally, run `bench start` to launch the backend | ||
|
||
The frappe framework-powered backend application should now be running. To run | ||
the Vue.js-powered frontend application, run `yarn dev` from the root | ||
directory. | ||
|
||
The website can now be accessed from `http://test.ballot:8080` and the backend | ||
frappe app can be accessed from `http://test.ballot:<port number>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |