Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webkom/vote
🗳️ Abakus' voting system
https://github.com/webkom/vote
angularjs hacktoberfest mongodb pug svelte
Last synced: 27 days ago
JSON representation
🗳️ Abakus' voting system
- Host: GitHub
- URL: https://github.com/webkom/vote
- Owner: webkom
- License: mit
- Created: 2014-09-24T17:33:56.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T14:53:56.000Z (about 2 months ago)
- Last Synced: 2024-10-22T00:48:10.873Z (about 2 months ago)
- Topics: angularjs, hacktoberfest, mongodb, pug, svelte
- Language: JavaScript
- Homepage: https://vote.abakus.no
- Size: 9.04 MB
- Stars: 27
- Watchers: 12
- Forks: 7
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ntnu - vote - Digital voting system with keycards (Mad science)
README
# vote [](https://ci.webkom.dev/webkom/vote) [](https://coveralls.io/github/webkom/vote?branch=master) [](https://libraries.io/github/webkom/vote#dependencies) 
> Digital voting system for Abakus' general assembly
## Setup
vote assumes you have a MongoDB-server running on `mongodb://localhost:27017/vote` and a redis-server running as `localhost:6379`. To change the URL, export `MONGO_URL` and `REDIS_URL` as an environment variable.
```bash
# Start MongoDB and Redis, both required for development and production
$ docker-compose up -d
# Install all dependencies
$ yarn
$ yarn dev # terminal 1, backend and old frontend
$ yarn dev:client # terminal 2, new frontend
```
## Usage
The following docs outline the technical usage, if you've got someone else to set it up for you and are looking for how to interact with the GUI, check out [HOWTO.md](./HOWTO.md) (in norwegian).
### Users
Initially you will need to create a moderator and or admin user in order to login
```bash
# Create a user via the CLI. You are prompted to select usertype.
$ ./bin/users create-user
```
### Card-readers
vote uses a RFID-reader to register and activate/deactivate users. This is done to make sure that only people that are at the location can vote. The RFID-reader needs to be connected to the computer that is logged in to the moderator panel. See section about using the card reader further down this readme.
### Development
> Check docs for the environment variable `ETHEREAL` if you intend to develop email related features
```bash
$ yarn start
```
### Environment variables
- `MONGO_URL`
- Url to the database connection
- `default`: `mongodb://0.0.0.0:27017/vote`
- `REDIS_URL`
- Hostname of the redis server
- `default`: `localhost`
- `ICON_SRC` _(optional)_
- Url to the main icon on all pages
- `default`: `/static/images/Abakule.jpg`
- `COOKIE_SECRET`
- **IMPORTANT** to change this to a secret value in production!!
- `default`: in dev: `localsecret`, otherwise empty
- `FRONTEND_URL`
- The site where vote should run
- `defualt`: `http://localhost:3000`
- `FROM`
- The name we send mail from
- `default`: `Abakus`
- `FROM_MAIL`
- The email we send mail from
- `default`: `[email protected]`
- `SMTP_URL`
- An SMTP connection string of the form `smtps://username:[email protected]/?pool=true`
- `GOOGLE_AUTH`
- A base64 encoded string with the json data of a service account that can send mail.
- `NODE_ENV`
- Node environment. `development`, `test` or `production`
See `app.js` and `env.js` for the rest
### Production
> For a production deployment example, see [deployment](./deployment/README.md) in the `deployment` folder
```bash
$ yarn build
$ ICON_SRC=https://some-domain/image.png NODE_ENV=production GOOGLE_AUTH=base64encoding yarn start
```
## Using the card-readers
Make sure you have enabled Experimental Web Platform features and are using Google Chrome. Experimental features can be enabled by navigating to: **chrome://flags/#enable-experimental-web-platform-features**.
Please check that the USB card reader is connected. When prompted for permissions, please select the card reader (CP210x).
### Serial permissions (Linux)
When using the card readers on a linux based system there can be permission problems with **google-chrome**. Chrome needs access to the ports, and often the ports are controlled by another group, so chrome cannot use them. Therefore you must do one of the following:
1. Run google-chrome as `root`
> NOTE: This has stopped working on modern versions of ubuntu-based distros, most likely due to the
> use of flatpak.
```sh
$ sudo google-chrome
```
**OR**
2. Add your user to the `dialout` group.
- Check what group the tty(USBPORT) is:
```
$ ls -al /dev/ttyUSB* | cut -d ' ' -f 2`
```
- Check what groups your user is added to:
```sh
$ groups
```
- Normally the `tty` is in the `dialout` group, so add your user to that group with:
```sh
$ sudo usrmod -a -G dialout $USER
```
> You need to sign in and out to get the new privileges!
## Tests
vote uses vitest for backend cypress for the frontent tests. To run them all you can do:
```bash
# Frontend (headless) and backend
$ yarn test
# Frontend with gui
$ yarn test:frontend
```
## Vote Occasion
We have a list of every occasion vote has been used. If you or your organization use vote for your event we would love if you made a PR where you append your event to the list.
The list is located at `./usage.yml`. Just create a new entry at the bottom. Then run `yarn lint` to see if your YAML is correct.
---
MIT © webkom, Abakus Linjeforening