:santa: The code behind Secret Santa, the holiday bot for Slack / Discord / Zoom
Just go to https://secret-santa.team/ and have fun.
Code source is under MIT License.
A Docker environment is provided and requires you to have these tools available:
Once castor is installed, in order to improve your usage of castor scripts, you
can install console autocompletion script.
If you are using bash:
castor completion | sudo tee /etc/bash_completion.d/castor
If you are using something else, please refer to your shell documentation. You
may need to use castor completion > /to/somewhere.
Castor supports completion for bash, zsh & fish shells.
The Docker infrastructure provides a web stack with:
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 secret-santa.test' | sudo tee -a /etc/hosts
Using dinghy? Run dinghy ip to get the IP of the VM.
We rely on some env variables to configure how to communicate with various
API’s and Redis.
Copy the content of the file .env into a new .env.local (which will be
ignored by git) and fill the missing vars with correct values.
Launch the stack by running this command:
castor 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 if you do not have mkcert
installed on your computer - see below).
This stack no longer embeds self-signed SSL certificates. Instead they will be
generated the first time you start the infrastructure (castor start) or if you
run castor infra:generate-certificates. So HTTPS will work out of the box.
If you have mkcert installed on your computer, it will be used to generate
locally trusted certificates. See mkcert documentation
to understand how to install it. Do not forget to install CA root from mkcert
by running mkcert -install.
If you don’t have mkcert, then self-signed certificates will instead be
generated with openssl. You can configure infrastructure/docker/services/router/openssl.cnf
to tweak certificates.
You can run castor infra:generate-certificates --force to recreate new certificates
if some were already generated. Remember to restart the infrastructure to make
use of the new certificates with castor up or castor start.
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:
castor builder
Checkout castor to have the list of available tasks.