Add mirror and fast clone method

This commit is contained in:
Mylloon 2021-11-01 22:37:52 +01:00
parent 7d30eae1f2
commit ce7ad42bb9

View file

@ -2,6 +2,7 @@
[![Version](https://img.shields.io/badge/version-1.7-green?style=for-the-badge)](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/releases)
[![Build](https://img.shields.io/gitlab/pipeline/ConfrerieDuKassoulait/KassouBot/dev?style=for-the-badge)](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/container_registry)
[![Mirror](https://img.shields.io/badge/Mirror-brightgreen?style=for-the-badge)](https://git.kennel.ml/ConfrerieDuKassoulait/KassouBot)
## __Features__
@ -77,6 +78,10 @@ To find Genius token, go to [this site](https://genius.com/api-clients), `login
## __Launching locally__
If you want to run it without Docker, clone the repo and his submodules by doing this command in the git folder:
```batch
git clone git@gitlab.com:ConfrerieDuKassoulait/KassouBot.git --recursive
```
If you already cloned the repo without the `--recursive` arg you can do that in the git folder :
```batch
git submodule update --force --recursive --init --remote
```
Then create an .env file to store variables in the root folder (there is an example [here](https://gitlab.com/ConfrerieDuKassoulait/KassouBot/-/blob/main/.envexample)).