Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romaixn/quizz-hop
Create your own quizz and play with.
https://github.com/romaixn/quizz-hop
cqrs ddd game hacktoberfest php quizz symfony web
Last synced: 17 days ago
JSON representation
Create your own quizz and play with.
- Host: GitHub
- URL: https://github.com/romaixn/quizz-hop
- Owner: Romaixn
- Created: 2021-05-28T06:59:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-26T11:39:42.000Z (about 3 years ago)
- Last Synced: 2024-05-01T18:15:20.368Z (7 months ago)
- Topics: cqrs, ddd, game, hacktoberfest, php, quizz, symfony, web
- Language: PHP
- Homepage: https://quizz-hop.fun/
- Size: 4.55 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# QuizzHop :tada:
## Running the application locally
### Requirements
A Docker environment is provided and requires you to have these tools available:
* Docker
* Bash
* pipenv (see [these instructions](https://pipenv.readthedocs.io/en/latest/install/) for how to install)
Install and run `pipenv` to install the required tools:
```bash
pipenv --three install
```
You can configure your current shell to be able to use Invoke commands directly
(without having to prefix everything by `pipenv run`)
```bash
pipenv shell
```
Optionally, in order to improve your usage of invoke scripts, you can install console autocompletion script.
If you are using bash:
```bash
invoke --print-completion-script=bash > /etc/bash_completion.d/invoke
```
If you are using something else, please refer to your shell documentation.
You may need to use `invoke --print-completion-script=zsh > /to/somewhere`.
Invoke supports completion for `bash`, `zsh` & `fish` shells.
### Docker environment
The Docker infrastructure provides a web stack with:
- NGINX
- PostgreSQL
- PHP
- Traefik
- ElasticSearch / Kibana
- RabbitMQ
- A container with some tooling:
- Composer
- Node
- Yarn / NPM
### Domain configuration (first time only)
Before running the application for the first time, ensure your domain names
point the IP of your Docker daemon by editing your `/etc/hosts` file.
This IP is probably `127.0.0.1` unless you run Docker in a special VM (docker-machine, dinghy, etc).
Note: The router binds port 80 and 443, that's why it will work with `127.0.0.1`
```
echo '127.0.0.1 ' | sudo tee -a /etc/hosts
```
Using dinghy? Run `dinghy ip` to get the IP of the VM.
### Starting the stack
Launch the stack by running this command:
```bash
inv start
```
> Note: the first start of the stack should take a few minutes.
The site is now accessible at the hostnames your have configured over HTTPS
(you may need to accept self-signed SSL certificate).
### Builder
Having some composer, yarn or other modifications to make on the project?
Start the builder which will give you access to a container with all these
tools available:
```bash
inv builder
```
Note: You can add as many Invoke commands as you want. If a command should be
ran by the builder, don't forget to use `with Builder(c):`:
```
@task
def mycommand(c):
"""
My documentation
"""
with Builder(c):
docker_compose_run(c, 'echo "HelloWorld")
```
### Other tasks
Checkout `inv -l` to have the list of available Invoke tasks.