Jikan - Unofficial MyAnimeList.net PHP API

September 20, 2024 ยท View on GitHub

Jikan

Jikan - Unofficial MyAnimeList.net PHP API

Netlify Status Discord Server

Jikan is an API for MyAnimeList.net. You can find more details here.

This repository represents Jikan's website - Jikan.moe. Please feel free to contribute and help improve it!

Contributing

This project is built using SvelteKit.

Pre-reqs: Node 18+, NPM

  1. Git clone & cd into project directory
  2. npm install
  3. Start the dev environment
npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

General Contributing Guidelines

When making changes, please fork the project and work on that.

Adding an integration

  1. Add a new JSON object entry in https://github.com/jikan-me/website/blob/master/src/data/integrations.js
  2. Ensure that you're adding it to the end of the list
  3. Validate the JSON and create a commit
  4. Create a PR

Important notes

  1. Add the language or framework you've built the project with in all lowercase in language
  2. supportsV3, supportsV4; These define which version of the REST API your integration supports. V3 is a backwards notifier for some of existing wrappers.
  3. url is the repository link of your integration

Adding a showcase item

  1. Add a new JSON object entry in https://github.com/jikan-me/website/blob/master/src/data/showcase.js
  2. Ensure that you're adding it to the end of the list
  3. Validate the JSON and create a commit
  4. Create a PR

Important notes

  1. Ensure that your summary is brief
  2. Host your preview images on IMGUR or GitHub but please optimize the size to ensure they're not more than 300KB
  3. The imageUrl has to be a direct link to the image (ending with the extension).
  4. Ensure that the url you are providing is accurate and up. This can be the URl to your app's website, install/download or repository page.

Modifying the website

We appreciate all the help in improving the experience of the site. Feel free to create a PR.

If there's something you can help with on our roadmap, that'd be very helpful as well.

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

Note: You do not have to build a production version to contribute. Comitting to the repository lets Netlify handle that and deployment for you.