reednote-backend

Backend part of the reednote project, powered by strapi

The project is mastered and led by: KevynTang

About the project

The Reednote project is an online note app project, demo: ReedNote

• Front end repo: reednote-frontend
• Back end repo: reednote-backend

Now it has had the following features:

• register / login
• create, upload, update, fetch or delete their notes
• notes create from open local files
• edit note in a WYSIWYG way
• table of contents
• good responsive design to allow high usability on both PC and mobile devices.
• note set (early stage)

current TODO list:

• finish the note set system
• images upload with static files server
• multiple authors
• improve editor UX

The project mainly powered by the following techniques, frameworks or libs:

• Milkdown
• Strapi
• Tailwind
• Vue.js
• TypeScript
• Vite

Install a instance

For the back-end part, yarn is used to manage packages.

clone this repo, go into the directory, then run:

yarn

When finished, remember to change the server configuration in config/server.js:

module.exports = ({ env }) => ({
  host: env('HOST', '0.0.0.0'),
  port: env.int('PORT', 1779),
});

run in development mode or build a production version with:

yarn develop
yarn run build