Skip to content

ForkKILLET/NyaDict

Repository files navigation

NyaDict

简体中文 | 日本語 | English

NyaDict is an open-source web dictionary for Japanese vocabulary memorying.

Demo: icelava.top/NyaDict/

Background

todo

Road Map

See our dev plan on Notion (Chinese).

Dev log videoes (Chinese)

Deployment

The main function of NyaDict is supplied by the frontend. The backend is only for data synchronizing.

Frontend

The frontend is static and usable after building.

pnpm i          # install dependencies
cd frontend     # get into frontend directory
pnpm build      # build

To configure backend URL, edit .env.production.

Develop:

pnpm dev

Backend

pnpm i      # install dependencies
cd backend  # get into backend directory
pnpm build  # build

To configure for develop or production mode, edit .env or .env.production.

To run in production mode:

pnpm start:prod

To run with pm2:

pnpm start:prod:pm2

To run in develop mode:

pnpm start:dev

Thanks

  • Koishi dev group. They helped me very much on developing NyaDict (about TypeScript, CSS, Vue, etc.). Koishi is a cross-platform chatbot framework made with love and high technological capability. Highly Recommended.