Skip to content

A responsive website for searching and displaying results from MyAnimeList.

License

Notifications You must be signed in to change notification settings

kdomasze/MAL-Search

Repository files navigation

MAL-Search

A responsive website for searching and displaying results from MyAnimeList.

A demo is available here.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development.

Prerequisites

Required

Optional

  • Node.js - Used to make setup of required and optional tooling more streamlined This project makes use of TSLint for linting and Prettier for formatting.

Compilation

Run sass src/sass/main.scss public/stylesheets/main.css and tsc from the root project directory to compile the Sass and Typescript files and output them to the correct destination.

Deployment

Move the contents of public to the desired location on your web server. The project will be served at 'domain.tld/path/to/project/index.html'.

Built With

  • JQuery - The JavaScript support library used
  • Node.js - The JavaScript runtime used to run tooling
  • Sass - the CSS Preprocessor used
  • Typescript - The compile-to-JavaScript language used
  • Normalize.css - The CSS reset library used
  • Jikan - The unofficial web API used to access MyAnimeList data

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Component styling loosely based off Google's Material Design guidelines and Bootstrap.