kirtanp98 / mangaupdates-graphql-api

A GraphQL api to fetch information from mangaupdates.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mangaupdates GraphQL Api

build badge GitHub package.json version GitHub

About The Project

Mangaupdates (Baka-Updates Manga) has one of the most vast amount of information on different series, scanlations groups, authors and etc. However, getting usable information from the website is hard and requires people to scrape.

Note: We are not affilated with mangaupdate.com.

Built With

Why both Puppeteer and Cheerio?

For some parts of mangaupdates, we need to interact with the page to get the data. While others we can use cheerio to parse the page, which is faster.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • node
  • npm
  • redis
    • Why don't you use docker to make it easier for people to install redis?
      • I'm not running the redis container on where I deploy the nestjs application, but I should really make use of it. It will probably be easier for people to use.

Installation

  1. Clone the repo
    $ git clone https://github.com/kirtanp98/mangaupdates-graphql-api.git
  2. Install NPM packages
    $ npm install
  3. Install Redis

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Contributing

I'm open to any contributions that will improve the app, add new feature, or fix any bugs. Contributions you make are greatly appreciated and recommended :). Just fork the repo, make a new branch and open a pull request.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Kirtan Patel - @Kirtanisnothere

Project Link: https://github.com/kirtanp98/mangaupdates-graphql-api

About

A GraphQL api to fetch information from mangaupdates.com

License:MIT License


Languages

Language:TypeScript 99.0%Language:JavaScript 1.0%