Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jolicode/secret-santa
:santa: The code behind Secret Santa, the holiday bot for Slack / Discord / Webex
https://github.com/jolicode/secret-santa
discord discord-bot hacktoberfest happyness secret-santa slack slack-blockkit slack-bot symfony symfony-flex webex
Last synced: about 2 months ago
JSON representation
:santa: The code behind Secret Santa, the holiday bot for Slack / Discord / Webex
- Host: GitHub
- URL: https://github.com/jolicode/secret-santa
- Owner: jolicode
- License: mit
- Created: 2015-11-09T17:55:07.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T10:39:45.000Z (9 months ago)
- Last Synced: 2024-08-02T05:19:58.446Z (5 months ago)
- Topics: discord, discord-bot, hacktoberfest, happyness, secret-santa, slack, slack-blockkit, slack-bot, symfony, symfony-flex, webex
- Language: PHP
- Homepage: https://secret-santa.team/
- Size: 10.8 MB
- Stars: 214
- Watchers: 20
- Forks: 19
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Secret Santa app
Just go to https://secret-santa.team/ and have fun.
Code source is under MIT License.
- This application is powered by Symfony;
- Hosting is provided by [Clever Cloud](https://www.clever-cloud.com/);
- Built with ♥ by [@pyrech](https://github.com/pyrech) and [@damienalexandre](https://github.com/damienalexandre).
## Running the application locally
### Requirements
A Docker environment is provided and requires you to have these tools available:
* Docker
* Bash
* PHP >= 8.1
* [Castor](https://github.com/jolicode/castor#installation)
#### Castor
Once castor is installed, in order to improve your usage of castor scripts, you
can install console autocompletion script.
If you are using bash:
```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.
### Docker environment
The Docker infrastructure provides a web stack with:
- NGINX
- Redis
- PHP
- Traefik
- 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 secret-santa.test' | sudo tee -a /etc/hosts
```
Using dinghy? Run `dinghy ip` to get the IP of the VM.
### Env vars configuration (first time only)
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.
### Starting the stack
Launch the stack by running this command:
```bash
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).
### SSL certificates
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](https://github.com/FiloSottile/mkcert#installation)
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](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`.
### 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
castor builder
```
### Other tasks
Checkout `castor` to have the list of available tasks.