Skip to content

Commit a482444

Browse files
Update README.md
1 parent a6b924f commit a482444

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,44 @@
33
</p>
44
<h2 align="center">Flypen</h2>
55
<p align="center">
6-
<!-- <a href="https://travis-ci.com/github/ybygjylj/habits-apriori/"><img src="https://travis-ci.com/ybygjylj/habits-apriori.svg?branch=master" alt="Build Status"></a> -->
7-
<a href="https://raw.githubusercontent.com/ybygjylj/habits-apriori/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="LICENSE"></a>
6+
<a href="https://raw.githubusercontent.com/stepbystepcode/flypen/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="LICENSE"></a>
87
<a href="https://github.com/topics/cpp"><img src="https://img.shields.io/badge/language-c++-blue.svg" alt="languange"></a>
9-
<!-- <a href="https://gitter.im/habits-apriori/community"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="chat"></a> -->
108
</p>
119

1210
*Read this in other languages: [English](README.md), [简体中文](README.zh_Hans.md).*
1311

1412
## C++ Course Design
1513
### An Office Collab Backend
1614
This is the Flypen C++ backend service for the Office Collab web application.
15+
Frontend Project for Flypen is [Here](https://github.com/stepbystepcode/flypen-frontend)
1716

1817
## Features
1918
- Real-time collaborative editing of documents
2019
- Chat and notifications
2120
- User management and access control
2221
- Document management and storage (markdown)
22+
2323
## Architecture
2424
- Server application built with C++ drogon famework
2525
- MariaDB database for storage
2626
- REST APIs for client communication
2727
- Use MySQL Connector/C++ 8.1.0 connect database
28-
## Getting Started
2928

30-
### Installing
29+
## Getting Started
3130

31+
### Installation (Automatic)
32+
```bash
33+
sudo apt install git gcc g++ cmake libjsoncpp-dev uuid-dev zlib1g-dev openssl libssl-dev
34+
git clone https://github.com/stepbystepcode/flypen.git --recursive
35+
cd flypen
36+
./run.sh
3237
```
38+
39+
### Installation (Manual)
40+
<details>
41+
<summary>Not Recommended</summary>
42+
<br><br>
43+
<pre>
3344
git clone https://github.com/stepbystepcode/flypen.git
3445
cd flypen
3546
git submodule update --init
@@ -55,25 +66,16 @@ mv mysql-connector-c++-8.1.0-linux-glibc2.28-x86-64bit mysql-connector
5566
rm mysql-connector-c++-8.1.0-linux-glibc2.28-x86-64bit.tar.gz
5667
mkdir build
5768
./run.sh
58-
```
59-
```
60-
#Another way (macos linux )
61-
sudo apt install git gcc g++ cmake libjsoncpp-dev uuid-dev zlib1g-dev openssl libssl-dev
62-
git clone https://github.com/stepbystepcode/flypen.git --recursive
63-
cd flypen
64-
./run.sh
65-
```
69+
</pre>
70+
</details>
71+
72+
73+
6674
## API Documentation
6775
See [API.md](API.md) for details on APIs for authentication, user management, documents, etc.
6876

69-
## Contributing
70-
See CONTRIBUTING.md for contribution guidelines.
71-
7277
## License
7378
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
7479

7580
## Contact
76-
For any questions, please reach out at [email protected]
77-
78-
79-
For any questions, please reach out at [email protected]
81+
For any questions, please reach out at [email protected] or [email protected]

0 commit comments

Comments
 (0)