thinhbg59 / lolibrary Goto Github PK

Lolibrary is a lolita fashion archive website. This repository is a monorepo containing code for what will eventually be all of Lolibrary.

To get started, you'll need to install Docker. This should be your only real requirement to run Lolibrary's code.

💻 On macOS, install Homebrew before you run bash setup.sh.

To get started, run bash setup.sh; you may be prompted for your password.

⚠️ Windows does not currently work with setup.sh; you'll need to run commands manually.

Copy .env.example to .env if it hasn't been done already; this is your entire config and sets environment variables. The default is enough to get started.

To run all code/containers, you'll need to run the following. This is your "normal" command to run to start Lolibrary running. This will start everything in the background; to start in the foreground just omit -d. To see logs, run docker-compose logs in the same directory as docker-compose.yml.

docker-compose up -d

Setup will have already ran this.

This will start the postgres/redis containers, spin up your web container to serve the application, run the queue workers, and build the frontend assets.

After making changes, your queue workers won't automatically restart. To do this, issue the following command:

docker-compose exec app php artisan horizon:terminate

docker-compose will automatically restart the container that was running queue workers.

Lolibrary in dev should be running on HTTPS, as that assumption is made everywhere. There is a self-signed certificate in the pki folder of this repository; you should trust this certificate on your development machine.

See the pki folder in this directory for more information; setup.sh will automatically add this certificate.

Add a dns resolver such as dnsmasq to resolve all .test domains to localhost. This will be needed! (setup.sh, again, does this automatically on Mac).

On windows, you can get away with just adding lolibrary.test to your hosts file pointing to 127.0.0.1

If you discover a security vulnerability within this repo, email [email protected]. All security vulnerabilities will be promptly addressed.

Lolibrary's code is licenced under the BSD Licence.

You may not use any of Lolibrary Inc's logos or trademarks without prior written permission.

Lolibrary Inc is a 501(c)(3) non-profit incorporated in the USA.