https://github.com/reednote-team/reednote-frontend
An online note management system base on milkdown editor
https://github.com/reednote-team/reednote-frontend
blog-platform milkdown notes-app wysiwyg
Last synced: 5 months ago
JSON representation
An online note management system base on milkdown editor
- Host: GitHub
- URL: https://github.com/reednote-team/reednote-frontend
- Owner: reednote-team
- License: gpl-3.0
- Created: 2021-12-13T14:28:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-25T10:43:40.000Z (over 3 years ago)
- Last Synced: 2024-12-06T17:13:44.338Z (about 1 year ago)
- Topics: blog-platform, milkdown, notes-app, wysiwyg
- Language: Vue
- Homepage: https://reednote.kevyn.cn
- Size: 3.2 MB
- Stars: 9
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reednote Frontend
front end part of the reednote project
The project is mastered and led by: [KevynTang](https://github.com/KevynTang)
## About the project
The Reednote project is an online note app project, **demo**: [ReedNote](https://reednote.kevyn.cn/)
- Front end repo: [reednote-frontend](https://github.com/reednote-team/reednote-frontend)
- Back end repo: [reednote-backend](https://github.com/reednote-team/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](https://github.com/Saul-Mirone/milkdown)
- [Strapi](https://strapi.io/)
- [Tailwind](https://tailwindcss.com/)
- [Vue.js](https://v3.vuejs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Vite](https://vitejs.dev/)
## Install a instance
For the front-end part, `yarn` is used to manage packages.
clone this repo, go into the directory, then run:
```bash
yarn
```
When finished, remember to change the APIs url in `main.ts` to your own url:
```typescript
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:
```bash
yarn dev
yarn build
```