Skip to content

㊗️ Web frontend for the JMdict Japanese-English dictionary project, with study list support! -- https://jisho.hlorenzi.com

Notifications You must be signed in to change notification settings

hlorenzi/jisho-open

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lorenzi's Jisho

Lorenzi's Jisho is a web frontend for the JMdict Japanese-English dictionary project! It supports creating and sharing custom study lists with your searched words, and you can export them in an Anki-compatible format.

It is live at https://jisho.hlorenzi.com

Discord

License

I haven't chosen how to license this repository's code yet. Please only use it for personal reference.

Local Development

To start:

  • Use node version 16 (or greater).
  • In all of common/, backend/, and frontend/, execute npm install.
  • If you have MongoDB installed, in backend/, execute npm run db-build to download JMdict and build the database.

To work on the codebase, execute in parallel:

  • In backend/, execute npm run dev to start the server in watch mode. You can pass arguments to select between a few options for internal services. Remember to pass as npm run dev -- --option.

    • For the database service:
      • --db-mongo Use MongoDB. This is the default.
      • --db-dummy Use a dummy interface that returns empty results.
    • For the authentication service:
      • --auth-dummy Use a dummy service which lets you log in with any user ID. This is the default.
      • --auth-lorenzi, --auth-lorenzi-dev Use Lorenzi's closed-source auth server. You probably won't have access to it, so use the dummy service.
  • In frontend/, execute npm run dev to build and pack the frontend JavaScript files in watch mode.

  • Finally, you can access the page through http://127.0.0.1.