Code Monkey home page Code Monkey logo

mal-chord's Introduction

MAL Chord ๐Ÿ“ˆ

MAL Chord is an interactive web-app that allows users to visualise their MyAnimeList library.

image

The application has been built as a single-page Preact project which communicates with a Node.js, Express middleware service.

This repository is responsible for managing all of the Preact (client-side) code.

Running locally

Initial Setup

To run the project locally, you will need to obtain your own client credentials through MyAnimeList (see Step 0 of this blog post for a guide on how to do this). During this process, you will be prompted to enter app information - the below values can be used:

Field Value
App Redirect URL http://localhost:8080
Homepage URL http://localhost:8080
App Logo URL http://localhost:3030/chord-logo

You will also need to setup and be running the MAL Chord middleware project which handles requests to the MyAnimeList API service.

Install and Configure

Once you have cloned the repository you will need to install the associated dependencies the project uses:

npm install

The following commands can be run in the project:

  • npm start - Runs the application in development mode (on port 8080)
  • npm run build - Builds the application for production to the build folder
  • npm run serve - Serves the production build locally (on port 8080)

Environment configuration can be specified by adding a .env file to the root of your local repository. A list of the variables needed for local development has been included below.

Key Value Purpose
PREACT_APP_CLIENT_ID Your MAL API Client ID Used to authenticate with MyAnimeList
PREACT_APP_API_URL http://localhost:3030 Middleware URL that requests will be sent to

What happened to mal-chord.com?

This site was originally deployed via Amazon services at mal-chord.com, however has been retired as of 20/08/2022 due to my free-tier of the Amazon services expiring. See below for an overview of the services that I utilised to get this running:

  • Amplify for Preact client
  • Elastic Beanstalk for Node.JS server
  • Route 53 to allow server to be accessed via api.mal-chord URL prefix

mal-chord's People

Contributors

johoseph avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.