Skip to content

reednote-team/reednote-frontend

Repository files navigation

Reednote Frontend

front end part of the reednote project The project is mastered and led by: KevynTang

About the project

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

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:

Install a instance

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

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

yarn

When finished, remember to change the APIs url in main.ts to your own url:

axios.defaults.baseURL = import.meta.env.PROD ? 'https://your.server.com/api' : 'http://localhost:1779/api'

run in development mode or build a production version with:

yarn dev
yarn build