Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kuduxaaa/markdown-notes
Markdown notes on Vue3 + backend (Flask RESTful)
https://github.com/kuduxaaa/markdown-notes
flask-restful markdown-editor markdown-notes markdown-viewer notes notes-app vue3
Last synced: about 1 month ago
JSON representation
Markdown notes on Vue3 + backend (Flask RESTful)
- Host: GitHub
- URL: https://github.com/kuduxaaa/markdown-notes
- Owner: Kuduxaaa
- Created: 2024-04-05T16:30:17.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-21T06:32:06.000Z (2 months ago)
- Last Synced: 2024-10-12T16:42:43.458Z (about 1 month ago)
- Topics: flask-restful, markdown-editor, markdown-notes, markdown-viewer, notes, notes-app, vue3
- Language: Vue
- Homepage: https://github.com/Kuduxaaa/markdown-notes
- Size: 649 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Markdown Notes App
Markdown Notes App is a web application built with Vue.js and Flask-RESTful for creating and managing markdown-based notes.
## Features
- Create, read, update, and delete markdown notes.
- Search functionality to find notes quickly.
- Responsive and intuitive user interface.
- Support for different themes.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/your-username/markdown-notes-app.git
```
2. Install backend dependencies:
```bash
cd backend
pip install -r requirements.txt
```
3. Install frontend dependencies:
```bash
cd frontend
npm install
```
## Usage
1. Configure MySQL database settings in `backend/config.py`
```python
DB_PORT = 3306
DB_HOST = 'localhost'
DB_USER = 'root'
DB_PASS = ''
DB_NAME = 'markdown-notes'
```
2. Create posts table
```bash
cd backend
python3 create_db.py
```
3. Run backend API Server
```
python main.py
```
4. Run frontend
```bash
cd frontend
npm run serve
```
5. Open your browser and visit [localhost:8080](http://localhost:8080) to access the application.
## Futures
- [ ] User Sign-in / Sign-Up
- [ ] Private notes
- [ ] Share note via link
- [ ] Realtime updates
- [ ] Posts page for guest
- [ ] Account page
## Contributing
Contributions are welcome! Please check the [Contributing Guidelines](CONTRIBUTING.md) for more information.