Mimor

[ Webwite | Manual | 手册 ]

Making memory a choice.

Development

npm install     # Install dependencies
npm run dev     # Start the dev server
npm run check   # Type check
npm run format  # Format the code

We use FiDB for our backend API.

To start the HTTP API server using the example database, run:

npm run api     # Start the backend server

Notes:

• Node.js version must be >= 20.1 or >= 18.17.0.
  • For the recursive option to readdir and opendir.
• To work with the frontend dev server, the backend API port should be 5108 (the default port of FiDB).
• The example username are xieyuheng and cicada-lang.
• The example passwords are all 123456.

If you do not want to start local backend using npm run api, you can use the production backend during development:

npm run dev:with-prod-backend  # Start the dev server with the production backend

Contributions

To make a contribution, fork this project and create a pull request.

Please read the STYLE-GUIDE.md before you change the code.

Remember to add yourself to AUTHORS. Your line belongs to you, you can write a little introduction to yourself but not too long.

License

GPLv3