/threetwo

A good comic book curation app.

Primary LanguageTypeScriptMIT LicenseMIT

ThreeTwo!

ThreeTwo! aims to be a comic book curation app.

Docker Image CI

Screenshots

Dashboard

Issue View

DC++ Search

Import

Comic Vine Matching, Metadata Scraping

🦄 Early Development Support Channel

Please help me test the early builds of ThreeTwo! on its official Discord

Discuss ideas and implementations with me, and get status, progress updates!

Dependencies

ThreeTwo! currently is set up as:

  1. The UI, this repo.
  2. threetwo-core-service
  3. threetwo-metadata-service
  4. threetwo-acquisition-service
  5. threetwo-ui-typings which are the types used across the UI, installable as an npm dependency.

Docker Instructions

See threetwo-docker-compose for instructions on building the entire stack.

Local Development

For debugging and troubleshooting, you can run this app locally using these steps:

  1. Clone this repo using git clone https://github.com/rishighan/threetwo.git
  2. yarn run dev (you can ignore the warnings)
  3. This will open http://localhost:5173 in your default browser
  4. 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

  1. docker-compose up is taking a long time

    This is primarily because threetwo-import-service pulls calibre from 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.

  2. What folder do my comics go in?

    Your comics go in the comics directory at the root of this project.

Contribution Guidelines

See contribution guidelines