Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wesleyklop/vote-system
Vote System is a general purpose voting application that, especially during these stay-at-home times can be useful in enabling digital voting.
https://github.com/wesleyklop/vote-system
anonymous laravel vote vote-system voting vue
Last synced: about 13 hours ago
JSON representation
Vote System is a general purpose voting application that, especially during these stay-at-home times can be useful in enabling digital voting.
- Host: GitHub
- URL: https://github.com/wesleyklop/vote-system
- Owner: WesleyKlop
- License: gpl-3.0
- Created: 2020-05-03T19:33:09.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-06T09:02:56.000Z (over 1 year ago)
- Last Synced: 2024-01-19T12:13:04.570Z (10 months ago)
- Topics: anonymous, laravel, vote, vote-system, voting, vue
- Language: PHP
- Homepage: https://vote-system.wesl.io
- Size: 7.69 MB
- Stars: 8
- Watchers: 1
- Forks: 4
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Vote System
Vote System is a general purpose voting application that,
especially during these stay-at-home times can be useful in enabling digital voting.
## Usage / Deployment
### Deployment with docker-compose
Docker compose should **not** be used for production! Use Swarm, K8s or similar instead.
The simplest way to run the application with almost zero configuration is by using docker-compose.
Just download the [docker-compose.yml](./docker-compose.yml) and [example environment file](./.env.example),
edit the environment file, verify the docker-compose file configuration and then run the following command:
```bash
docker-compose up -d
```
This will automatically initialize a database, create an application key, run the migrations,
set up the admin user and start the application! By default, the application will be reachable via [localhost:8080]
(http://localhost:8080).
### Manual docker deployment
The easiest way to use and deploy this application is using Docker.
You can grab the latest version from this GitHub or use a certain tag by viewing the [ghcr versions page](https://github.com/users/WesleyKlop/packages/container/vote-system/versions).
### Prerequisites
Before you get ready to start the docker image, you should set up the following:
- A database like Postgres or MySQL.
- I recommend Postgres because that is what I personally use and also what is used by the CI pipeline.
- Copy the [.env](./.env.example) file from this repository, save it somewhere and fill in your database credentials.
The application will automatically configure an application key if it could not be found on first run.
You will also need to configure the websockets secret. (`PUSHER_APP_SECRET`)
### Using
You can now run the following two commands to start the websockets server and the webserver.
You can modify the below environment variables.
```bash
ENV_FILE=/abs/path/to/your/.env-file
IMAGE=ghcr.io/wesleyklop/vote-system:main
WEB_PORT=8080 # Make sure this matches the port in APP_URL
docker run --rm -d -p 6001:6001 -v $ENV_FILE:/app/.env $IMAGE php artisan websockets:serve
docker run --rm -d -p $WEB_PORT:80 -v $ENV_FILE:/app/.env $IMAGE
```
I would recommend using the docker-compose file instead.
## Screenshots
## Contributing
Contributing guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md)
## Security Vulnerabilities
If you discover a security vulnerability within Vote system, please send an e-mail to Wesley Klop via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
## License
The Vote system is open-sourced software licensed under the [GPLv3](https://opensource.org/licenses/GPL-3.0).