lolibrary / lolibrary Goto Github PK

View Code? Open in Web Editor NEW

75.0 14.0 14.0 20.56 MB

👗The Lolita Fashion Library 👒

Home Page: https://lolibrary.org

License: BSD 3-Clause "New" or "Revised" License

Shell 1.79% Go 38.74% PHP 44.26% Vue 2.32% HTML 12.87% Dockerfile 0.03%

fashion laravel docker kubernetes

lolibrary's Introduction

Lolibrary

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

Getting Started

To get started, you'll need to install Docker and the go compiler. You'll also need kubectl at a minimum, and if you're a Lolibrary core dev, access to our GKE cluster (ask on Discord, and use your @lolibrary.org email).

As a note, this only really supports macOS right now.

First, run ./bin/install. This will compile all Go tools and stick them into $GOPATH/bin. Add this to your path if needed!

💻 On macOS, you can install Homebrew to get all of these tools.

Running internal tools

To communicate with production (or your local environment), see Flower CLI
To deploy, see Deploying Lolibrary
To connect to CockroachDB, see Connecting to CockroachDB

HTTPS certificate

Lolibrary's ingress 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.

Then, provided you follow the guidance below, you'll be able to reach:

lolibrary.test:443 (main user frontend)
api.lolibrary.test:443 (all services that start with service.api.)
admin.lolibrary.test:443 (admin user frontend)
image-proxy.lolibrary.test:443 (a proxy to our configured CDN so that you load images locally)

This is only needed when running full tests across the entire platform. In most cases when you test a service in isolation you don't use the ingress, so you can just find it on localhost.

Hostnames

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 and related domains to your hosts file pointing to 127.0.0.1

Security Vulnerabilities

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

License

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.

lolibrary's People

Contributors

Stargazers

Watchers

Forkers

fossabot momijizukamori ianmcorvidae frontsideair suyanhanx thinhbg59 charlotteann-p jonmelcher monyancha bunnyxt jhchoac networksystemone maksimalno

lolibrary's Issues

Set up Travis CI

We need automated testing for PHP services (e.g. the website), as well as Go services (e.g. the API).

For now, let's just add a Travis CI matrix per-service.

Adding attributes without a value causes a database null error

Sentry link: https://sentry.io/organizations/lolibrary/issues/1771678311/?project=88264

php max upload size is too low on abiosoft/caddy

Currently if we try and submit a request body higher than 8MB, everything breaks.

What is this for

Add description to README?

We need CI/CD set up for our GKE cluster

Currently, deploying is just something I run manually on my laptop, via build scripts in a private repo (https://github.com/lolibrary/build for org members).

We can more-or-less port these to github actions and use GCP's GitHub actions toolkit to interact with kubernetes.

We can also have a two-stage build process for staging/production and require tests to pass first.

Set up staging/production namespaces with a single ingress

This is a little project I've been working on.

We can have our ingress (a LoadBalancer) set up in the default namespace. This can then route to an ingress we have inside multiple namespaces based on hostname, e.g.:

lolibrary.org -> production
lolibrary.space -> staging
lolibrary.test -> local

We can stick with host-based routing at the moment, too - api., etc can go to service.api, apex -> service.sakura.

We can stick with cluster DNS for now, and use a service mesh later if needed.

Windows Docker (Toolbox) Service lolibrary_www Start Error - Mount a directory onto a file error.

Dear Lolibrary Community,

I tried to build and run the Lolibrary on Windows 10 x64, unfortunately I got the following error message:

ERROR: for lolibrary_www.lolibrary.test_1
Cannot start service www.lolibrary.test:
OCI runtime create failed:
container_linux.go:348:
starting container process caused "process_linux.go:402:
container init caused "rootfs_linux.go:58:
mounting \"/host_mnt/e/lolibrary/.env\"
to rootfs \"/var/lib/docker/overlay2/c64e98c6fd0e2bc401e80ace3e12cf2df04f203e0d693e80ff3eccf238f26e3d/merged\"
at \"/var/lib/docker/overlay2/c64e98c6fd0e2bc401e80ace3e12cf2df04f203e0d693e80ff3eccf238f26e3d/merged/secrets/environment/.env\"
caused \"not a directory\""":
unknown: Are you trying to mount a directory onto a file (or vice-versa)? Check if the specified host path exists and is the expected type
ERROR: Encountered errors while bringing up the project.

It fails when trying to start lolibrary_www.lolibrary.test_1 service.

Besides that I created a Powershell Script to make it possible to install the required things on Windows.
And everything install (rename .var.example, certificate, docker pull) as required works and is tested on Windows 10 (script as file can be seen on my fork).