2.4 KiB
ThreeTwo!
ThreeTwo! is a comic book curation app.
⚠️ This project is in early stages of development and as such, not ready for general use.
Dependencies
ThreeTwo! currently is set up as:
- The UI, this repo.
- threetwo-import-service
- comicvine-service
- threetwo-ui-typings which are the types used across the UI, installable as an
npmdependency.
Docker Instructions
The recommended approach is to simply use docker-compose which spins up containers for the UI and all the associated microservices and data store.
Make sure that you have docker and docker-compose installed. Running docker system prune -a can help free up some space.
Then:
- Clone this repo using
git clone https://github.com/rishighan/threetwo.git - Create an external docker network using
docker network create proxy - Run
docker-compose up --build -dto run the containers in detatched mode - For debugging, run
docker-compose up --build - Note that the first time, the process could take up to 10 minutes, since it is building containers for
threetwo,threetwo-import-service,comicvine-service,mongo,nats,nginx - For posterity, check that all containers are up using
docker ps
Local Development
For debugging and troubleshooting, you can run this app locally using these steps:
- Clone this repo using
git clone https://github.com/rishighan/threetwo.git yarn run dev(you can ignore the warnings)- This will open
http://localhost:3050in your default browser - Note that this is simply the UI layer and won't offer anything beyond a scaffold. You have to spin up the microservices locally to get it to work.
Troubleshooting
Docker
-
docker-compose upis taking a long timeThis is primarily because
threetwo-import-servicepullscalibrefrom the CDN and it has been known to be extremely slow. I can't find a more reliable alternative, so give it some time to finish downloading. -
What folder do my comics go in?
Currently, in the
docker-composesetup, thecomicsfolder at the root of this repo is used to store comics.