Open Source Shakespeare API

This API provides access to the works of Shakespeare, including plays, sonnets, and other works. The data is sourced from the public domain works of Shakespeare and is provided in a structured format for easy consumption by developers.

Getting started

Prerequisites

To run this project, you will need to have the following software installed on your system:

• Node.js (version 12 or higher)
• Npm (version 6 or higher)
• Docker

Installation

Clone the repository:

  git clone https://github.com/mghmay/open-source-shakespeare-api

Navigate to the project directory:

  cd open-source-shakespeare-api

Build and start the Docker container:

  docker-compose up --build

The server should now be running on http://localhost:3000.

Running the server

To start the server in dev mode, run the following command:

  npm run start:dev

The server will start listening on port 3000 by default. You can change the port number by setting the PORT environment variable.

API Reference

The documentation can be found here: documentation

License

MIT - See licence file for more details