This project provides an organized web interface for easy access to a haphazardly stored collection of digital comics. This project is designed for personal use on a home LAN. It would be a terrible mistake to provide access to the Internet to your local install of this project.
After copying the files for the application to your system, you create the database and prepare it for the application. Then it is time to mount whatever drive has your files on it to the public/comics/ directory. Once running, the application scrapes information about your comics into a database that provides an organized view of your comics. The homepage shows links to the various publishers. After selecting a publisher, you are presented with a page of many of the main characters from that publisher to choose from. Clicking on a character's name will take you to a page of comic titles this character can be found in. Clicking on a title will take you to a page that displays all of the issues for this comic title that are available. Now you can easily add an issue to your comic reading device of choice.
- Install Git (sudo apt install git)
- Install RBEnv (sudo apt install rbenv, rbenv init)
- this will make working with Ruby gems easier later
- Install Ruby (rbenv install 3.0.0)
- Set the local version of Ruby to 3.0.0 (rbenv local 3.0.0)
- Install Bundler (gem install bundler)
- Install all gems for this project (bundle install)
- Mount where your comics are located (sudo mount /dev/sda1 /srv/dci-sinatra/public/comics/)
- If you reboot your server, you will likely need to mount this again
Each of the following commands should be run from inside the VeCO directory
- Create the database (rake db:create)
- Run migrations on the database (rake db:migrate)
- Scrape the contents of your comics into the database (rails db:seeds)
- depending on how many files you have, this may take a while (like, a minute per couple hundred)
- Start the server (rails s) access the server (ie http://localhost:3000 or http://192.168.1.xxx:3000)
AGAIN, THIS SOFTWARE IS DESIGNED TO ONLY RUN ON A LAN, NOT AN INTERNET ACCESSIBLE SERVER!
- Make comics viewable (like a slideshow of pages) in the browser
- Add more characters to the data file
- clean up the interface
- add header and footer
- add navigation
- re-design publishers page and functionality
- RTKimz - Initial work - rtkimz
See also the list of contributors who participated in this project.
This project is licensed under the MIT License.