{"id":21368082,"url":"https://github.com/open-webtoon-reader/owr-api","last_synced_at":"2026-05-17T02:05:48.936Z","repository":{"id":238096887,"uuid":"795863644","full_name":"Open-Webtoon-Reader/OWR-API","owner":"Open-Webtoon-Reader","description":"Rest API for future webtoon reader (and downloader) app","archived":false,"fork":false,"pushed_at":"2024-05-22T14:46:33.000Z","size":431,"stargazers_count":2,"open_issues_count":9,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-05-22T15:56:39.189Z","etag":null,"topics":["nestjs","prisma","restful-api","typescript","webtoon-downloader","webtoon-reader"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Open-Webtoon-Reader.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-04T09:25:19.000Z","updated_at":"2024-05-28T16:39:32.025Z","dependencies_parsed_at":"2024-05-28T16:39:18.788Z","dependency_job_id":null,"html_url":"https://github.com/Open-Webtoon-Reader/OWR-API","commit_stats":null,"previous_names":["open-webtoon-reader/owr-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-Webtoon-Reader%2FOWR-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-Webtoon-Reader%2FOWR-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-Webtoon-Reader%2FOWR-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-Webtoon-Reader%2FOWR-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Open-Webtoon-Reader","download_url":"https://codeload.github.com/Open-Webtoon-Reader/OWR-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243841217,"owners_count":20356446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nestjs","prisma","restful-api","typescript","webtoon-downloader","webtoon-reader"],"created_at":"2024-11-22T07:22:37.660Z","updated_at":"2025-10-27T15:45:43.483Z","avatar_url":"https://github.com/Open-Webtoon-Reader.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Open Webtoon Reader - API\n\nA RESTful API for the upcoming webtoon reader and downloader application.\n\n## Table of Contents\n- [Overview](#overview)\n- [Features](#features)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n  - [Running the Application](#running-the-application)\n    - [On a basic server](#on-a-basic-server)\n    - [With Pterodactyl](with-pterodactyl)\n- [Configuration](#configuration)\n- [API Endpoints](#api-endpoints)\n- [Technologies Used](#technologies-used)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Overview\nOWR-API provides endpoints to fetch, read, and download webtoons, supporting the webtoon reader and downloader application.\n\n## Features\n- Download and save webtoons\n- Fetch webtoons, episodes list and content\n\n## Getting Started\n\n### Prerequisites\n- Node.js\n- npm/pnpm package manager\n\n### Installation\n1. Clone the repository:\n   ```sh\n   git clone https://github.com/Open-Webtoon-Reader/OWR-API.git\n   cd OWR-API\n   ```\n2. Install dependencies:\n   ```sh\n   pnpm install\n   ```\n\n## Configuration\nCreate a `.env` file in the root directory with the following variables:\n```ini\n# Server\nSERVER_TYPE=\"http\"\nBIND_ADDRESS=\"0.0.0.0\"\nHTTP_PORT=\"3000\"\nHTTPS_PORT=\"3001\"\n\n# SSL\nSSL_KEY_FILE=\"\"\nSSL_CERT_FILE=\"\"\n\n# API\nPREFIX=\"api/v1/\"\n\n# Security\nADMIN_KEY=\"admin\"\n```\n\n### Running the Application\n#### On a basic server\n1. Start the server:\n   ```sh\n   npx prisma generate\n   npx prisma migrate deploy\n   npx prisma db seed\n   pnpm run start\n   ```\n2. The API will be available at `http://localhost:3000` (depending of your `.env` configuration).\n\n#### With Pterodactyl\n1. Create a new service on your Pterodactyl panel from nodejs egg.\n2. Configure the startup command as the following:\n   ```sh\n   if [ ! -d \"OWR-API\" ]; then git clone https://github.com/Open-Webtoon-Reader/OWR-API; fi; cd OWR-API || exit; git pull; if [ ! -f \".env\" ]; then cp .env.example .env; fi; npm install --force; npx prisma generate; npx prisma migrate deploy; npx prisma db seed; npm run start\n   ```\n\n## API Endpoints\nThe API endpoints will be available at `http://localhost:3000/api/` (depending of your `.env` configuration).\n\n## Technologies Used\n- **TypeScript**\n- **NestJS**\n- **Prisma**\n- **RESTful API**\n\n## Contributing\nContributions are welcome! Please fork the repository, create a feature branch, and submit a pull request.\n\n## License\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-webtoon-reader%2Fowr-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-webtoon-reader%2Fowr-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-webtoon-reader%2Fowr-api/lists"}