Skip to content

Commit 53a5939

Browse files
aircjmaircjm
committed
update readme.md
1 parent 9f6f848 commit 53a5939

File tree

2 files changed

+141
-17
lines changed

2 files changed

+141
-17
lines changed

‎README.md

Lines changed: 83 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,101 @@
1-
# limon
1+
# Limon - Personal Note Management Service
22

3-
## Documentation
3+
Limon is an easy-to-setup personal note management service designed for simplicity, stability, and scalability.
44

5+
## Project Vision
56

6-
## Community
7+
The Limon project aims to create a simple, stable, and scalable personal note management service with the easiest setup possible. Future plans include expanding into a comprehensive GTD (Getting Things Done) and Zettelkasten note-taking service, integrating personal time management and note management into a unified information management service.
78

8-
## Features
9+
Since Limon uses Markdown, it requires specific templates for Markdown formatting.
910

10-
this is a monorepo fullstack project about a card mgt project in different language.
11+
- **Intuitive Data Management**: Display data in a card format to allow users to manage and operate data intuitively.
12+
- **Flexible Function Expansion**: Support merging cards, countdown functions, and other features to meet different scenarios.
13+
- **Front-end and Back-end Separation**: Use Java for the back-end and Vue 3 for the front-end to achieve a separated architecture, improving development efficiency and maintainability.
14+
- **Easy Deployment**: Use Docker for back-end deployment to simplify the deployment process and reduce operational costs.
1115

12-
### backend
16+
## Key Features
1317

14-
Please see [limon-server](./java/README.md).
18+
- **Import Trello Notes**: Easily import notes from Trello.
19+
- **Convert to Anki Notes**: Automatically convert note content into Anki-compatible Markdown notes for review and retention.
20+
- **Card Display**: Display data in a card format with support for multiple card layouts.
21+
- **Card Management**: Support creating, editing, deleting, and searching cards.
22+
- **Card Merging**: Support merging multiple cards into one card for easy data integration.
23+
- **Countdown Function**: Add countdown functions to cards, suitable for scenarios requiring timed reminders.
24+
- **Responsive Design**: Support responsive layouts for different devices to ensure good display on various devices.
1525

16-
### frontend
26+
## Important Notes
1727

18-
Please see [vite-naiveui](./vue/vite-naiveui/README.md).
28+
- **Database Configuration**: Ensure you specify the correct database for your setup.
1929

20-
### Fast
30+
### Initializing the Database
2131

22-
I try to make it not rather slow. At least select, tree, transfer, table and cascader work with virtual list.
32+
```shell
33+
docker run -it --name limon-mysql -p 3306:3306 -v /d/dockerDrive/mysql:/app -e MYSQL_DATABASE=limon -e MYSQL_USER=db_test -e MYSQL_PASSWORD=123456 -e MYSQL_ROOT_PASSWORD=123456 mysql:8.0
34+
```
2335

24-
What's more, ..., no more. Just enjoy it.
2536

26-
## Installation
37+
## Deployment Details
2738

28-
## Contributing
39+
### Front-end Deployment
2940

30-
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).
41+
1. **Build for Production**:
42+
```bash
43+
cd vue/vite-naiveui
44+
npm run build
45+
```
46+
47+
2. **Deploy to Server**:
48+
Deploy the files in the `dist` directory to your web server (such as Nginx, Apache) or static file hosting service (such as GitHub Pages, Netlify).
49+
50+
### Back-end Deployment
51+
52+
1. **Deploy Using Docker**:
53+
```bash
54+
docker run -d -p 8080:8080 --name limon-backend-container limon-backend
55+
```
56+
57+
2. **Configure Database**:
58+
Ensure the database service is running and configure the database connection information correctly in the backend configuration file.
59+
60+
## Contributing Guidelines
61+
62+
We welcome contributions from the community! If you are interested in contributing to the Limon project, please follow these steps:
63+
64+
1. **Fork the Project**: Click the "Fork" button on the GitHub page to fork the project to your GitHub account.
65+
66+
2. **Create a Branch**: Create a new branch in your forked project for developing your feature or fixing a bug.
67+
68+
3. **Submit a Pull Request**: After completing the development, submit a Pull Request describing your changes and purpose.
69+
70+
4. **Code Review**: The project maintainers will review your Pull Request and provide feedback.
71+
72+
5. **Merge Code**: Once the Pull Request is accepted, your code will be merged into the main branch.
3173

32-
## License
3374

34-
Naive UI is licensed under the [MIT license](https://opensource.org/licenses/MIT).
75+
## Backup and Restore
76+
77+
### Backup
78+
79+
```shell
80+
docker exec limon-mysql /usr/bin/mysqldump -u root --password=root limon > backup.sql
81+
```
82+
83+
### Restore
84+
85+
```shell
86+
docker exec -i limon-mysql mysql -u root --password=root limon < backup.sql
87+
```
88+
89+
90+
91+
## Special Thanks
92+
93+
- **Anki Markdown Integration**: Thanks to [Using Markdown in Anki](https://zhuanlan.zhihu.com/p/137570649) for guidance on displaying Markdown in Anki.
94+
- **RuoYi Scaffold**: Thanks to [RuoYi](https://gitee.com/y_project/RuoYi-Vue) for the project scaffold design.
95+
- **JetBrains Support**: Special thanks to JetBrains for their open-source license support.
96+
97+
[![jetbrains.svg](jetbrains.svg)](https://www.jetbrains.com/?from=limon)
98+
99+
## License
35100

101+
This project is licensed under the MIT License. Full license details can be found in the [LICENSE](https://github.com/aircjm/limon/blob/master/LICENSE) file.

‎java/README_EN.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Limon - Personal Note Management Service
2+
3+
Limon is an easy-to-setup personal note management service designed for simplicity, stability, and scalability.
4+
5+
## Project Vision
6+
7+
The Limon project aims to create a simple, stable, and scalable personal note management service with the easiest setup possible. Future plans include expanding into a comprehensive GTD (Getting Things Done) and Zettelkasten note-taking service, integrating personal time management and note management into a unified information management service.
8+
9+
Since Limon uses Markdown, it requires specific templates for Markdown formatting.
10+
11+
## Key Features
12+
13+
- **Import Trello Notes**: Easily import notes from Trello.
14+
- **Convert to Anki Notes**: Automatically convert note content into Anki-compatible Markdown notes for review and retention.
15+
16+
## Important Notes
17+
18+
- **Database Configuration**: Ensure you specify the correct database for your setup.
19+
20+
### Initializing the Database
21+
22+
```shell
23+
docker run -it --name limon-mysql -p 3306:3306 -v /d/dockerDrive/mysql:/app -e MYSQL_DATABASE=limon -e MYSQL_USER=db_test -e MYSQL_PASSWORD=123456 -e MYSQL_ROOT_PASSWORD=123456 mysql:8.0
24+
```
25+
26+
## Backup and Restore
27+
28+
### Backup
29+
30+
```shell
31+
docker exec limon-mysql /usr/bin/mysqldump -u root --password=root limon > backup.sql
32+
```
33+
34+
### Restore
35+
36+
```shell
37+
docker exec -i limon-mysql mysql -u root --password=root limon < backup.sql
38+
```
39+
40+
## Special Thanks
41+
42+
- **Anki Markdown Integration**: Thanks to [Using Markdown in Anki](https://zhuanlan.zhihu.com/p/137570649) for guidance on displaying Markdown in Anki.
43+
- **RuoYi Scaffold**: Thanks to [RuoYi](https://gitee.com/y_project/RuoYi-Vue) for the project scaffold design.
44+
- **JetBrains Support**: Special thanks to JetBrains for their open-source license support.
45+
46+
[![jetbrains.svg](jetbrains.svg)](https://www.jetbrains.com/?from=limon)
47+
48+
## License
49+
50+
This project is licensed under the MIT License. Full license details can be found in the [LICENSE](https://github.com/aircjm/limon/blob/master/LICENSE) file.
51+
52+
## References
53+
54+
For additional backup and restore commands, refer to:
55+
56+
```shell
57+
docker exec mysql_container_name /usr/bin/mysqldump -u user_name --password=user_password db_name > backup.sql
58+
```

0 commit comments

Comments
 (0)