stolaar / anime

Anime Repository

This repository hosts two applications: a REST API backend written in Golang and a web application frontend written in React. The backend provides endpoints for fetching animes and episodes, as well as scraping episode sources from a third-party website to embed as iframes in the web application. The frontend consists of two pages: one for listing animes and another for listing and playing anime episodes.

Table of Contents

• Backend
  • Libraries Used
  • Endpoints
• Frontend
  • Technologies Used
  • Pages
• Setup
  • Backend Setup
  • Frontend Setup
• Contributing
• License

Backend

Libraries Used

• Migrations: go-migrations
• JWT: golang-jwt
• Swagger: echo-swagger
• Mocking DB: go-mocket
• ORM: gorm

Endpoints

• Fetch Animes

  • GET /api/animes
  • Fetch a list of all available animes.

• Fetch Episodes

  • GET /api/animes/:id
  • Fetch a list of episodes for a specific anime.

• Scrape Episode Source

  • GET /episodes/:id/src
  • Scrape the source of an episode from a third-party website and embed it as an iframe.

Frontend

Technologies Used

• TailwindCSS: for styling
• TypeScript: for type-safe JavaScript
• Vite: for fast development and build tooling

Pages

• Anime List

  • Displays a list of all available animes.

• Episode List and Player

  • Displays a list of episodes for a selected anime.
  • Allows playing an episode by embedding it as an iframe.

Setup

Backend setup

1. Install dependencies

make install-api

2. Run Migrations

make migrate

3. Run

make dev-api

or run both

make -j2

Frontend setup

1. Install dependencies

make install-client

2. Run

make dev-client