README.md

LNCrawler Website

LNCrawler Website is a react web frontend for lightnovel-crawler. The aim is to create a light novel and web novel aggregator website with an user-generated database from more than 200+ sources.

A live demo is availible at https://lncrawler.monster/

• LNCrawler Website
  • to get started
    • Prerequisites
    • Installation
  • Start the website
    • Run the developement server
    • Run the production server
  • Adding a Novel
  • Build with
  • Authors
• More informations
• Pictures

to get started

Prerequisites

You will need

• python to run the backend
• nodejs for the front-end
• git to download and update the code.

Installation

• First clone the repository:

git clone https://github.com/jere344/lightnovel-crawler.git

• Open command prompt inside of the project folder and install requirements:

pip install -r requirements.txt
pip install -r requirements-bot.txt
pip install -r requirements-website.txt

• Move into lncrawl/bots/web2/react-app/ and install requirements :

cd lncrawl/bots/web2/react-app
npm install

Start the website

Run the developement server

• First start the backend bot

python lncrawl --bot web2

• Then start the frontend server

cd lncrawl/bots/web2/react-app
npm start

Adding a novel to the server

• Visit http://localhost:3000/addnovel or just click on Add Novel on the website and in the search bar type in a novel's name or a URL of a novel from a supported source.
• If you search using a novel's name there will be multiple sources from which you can add novel to the server. You can check out a source by clicking on the URL of the novel and it should open in a new tab.

Run the production server

You will need to install serve

cd lncrawl/bots/web2/react-app
npm install -g serve

• Edit the configuration file lncrawl/bot/web2/flask_api/config.json with your domain name, and set dev_mode to false:

"dev_mode": "false",
"website_url": "https://lncrawler.monster",
"api_url": "https://api.lncrawler.monster",

• Copy the configuration file to the frontend folder :

cp "lncrawl/bots/web2/flask_api/config.json" "lncrawl/bots/web2/react-app/src/"

• Start the backend bot

python lncrawl --bot web2

• Build the frontend

cd lncrawl/bots/web2/react-app
npm run build

• Serve the frontend server

cd lncrawl/bots/web2/react-app
serve -s build

For the rest you will need some kind of reverse proxy like nginx or apache2 to serve the backend and the frontend.

---

For example, this is my config.json :

{
    "dev_mode": "false",
    "dev_website_url": "http://localhost:3000",
    "dev_api_url": "http://localhost:5000",
    "website_url": "https://lncrawler.monster",
    "api_url": "https://api.lncrawler.monster",
    "max_ebook_size": 300000000,
    "api_host" : "192.168.2.18",
    "api_port" : 5000
}

Build with

• lightnovel-crawler - LNCrawler Website is based on lightnovel-crawler
• React - The web framework used
• python - The backend language

Authors

• @jere344

And all the contributors of lightnovel-crawler

---

More informations

More general informations can be found in the lightnovel-crawler repository.

Pictures

• Light Theme:

• Dark Theme: