Giter Club home page Giter Club logo

ao3-api-js's Introduction

ao3-api

An API to scrape archiveofourown.org fanfiction metadata using the fetch-ao3 library that I created for scraping archiveofourown.org. Currently it can search for archiveofourown.org works to get different metadata like author name, chapter count, word count, genre, ratings etc

Features:

  • Fetch fanfiction works from archiveofourown.org
  • Fetch the local metadata from the database

Setup

Docker

Docker image

Build manually

# Inside the git repository
docker build -t arzkar/ao3-api-js .

Docker Hub

docker pull arzkar/ao3-api-js

Run the docker

docker-compose up

Manual

Environment variables

Add the "TOKEN_KEY", "DEFAULT_ADMIN_USER", "DEFAULT_ADMIN_PWD" & "DOCKER" for the API in a .env file in the project's root directory.
An example file is present called .env.ex

API

  • Clone the repository & run npm install
  • Run the development API server using npm run dev
  • Run the production API server by:
npm run deploy

Endpoints & Parameters

  • /api/live/search: To scrape an AO3 works by workUrl
  • /api/archive/search: To search the database for an AO3 works by workUrl
  • /api/archive/update:
    • To update a metadata in the database by workUrl
    • Requires a token to authenticate
    • Send the "token" in the body, query or the headers
  • /api/archive/delete:
    • To delete a metadata in the database by workUrl
    • Requires a token to authenticate
    • Send the "token" in the body, query or the headers
  • /api/auth:
    • To get the JWT token to authenticate /update & /delete endpoints
    • Send the "user" & "password" in the body and the token is returned

ao3-api-js's People

Contributors

arzkar avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.