Showing
1 changed file
with
49 additions
and
0 deletions
README.md
0 → 100644
1 | +# **Running Football** | ||
2 | + | ||
3 | +## contents | ||
4 | +* About the Project | ||
5 | +* Getting Started | ||
6 | +* Usage | ||
7 | +* Roadmap | ||
8 | +* Contribution | ||
9 | +* License | ||
10 | +* Contact | ||
11 | + | ||
12 | +--- | ||
13 | +*** | ||
14 | +--- | ||
15 | + | ||
16 | + | ||
17 | +## **About the Project** | ||
18 | + | ||
19 | +A minimalistic version of PC football blog. The front-end project is mainly built using Vue2 and Element-UI; it is built and packaged using Webpack5. The back-end project is mainly designed using the Node framework Koa2 and the MongoDB database. | ||
20 | +###The main function | ||
21 | + | ||
22 | +#### Client | ||
23 | + | ||
24 | +1. Article function: the content of the article supports `Markdown` syntax and the code is highlighted; | ||
25 | +2. Tag function: retrieve article data by tag classification; | ||
26 | +3. Sidebar function: click ranking, webmaster recommendation, tag classification, etc.; | ||
27 | +4. Search function: search the title and abstract of the article by keywords, and support search highlighting; | ||
28 | +5. Message function: you can like, reply to comments, count comments and the total number of replies, support `Emoji` emoticons; | ||
29 | +6. Other functions: image lazy loading, paging, sidebar top and one-click top, etc.; | ||
30 | + | ||
31 | +####Management | ||
32 | + | ||
33 | +1. Authority management: CRUD administrator, who can assign authority; | ||
34 | +2. Article management: CRUD articles, article covers support local upload, article content supports `Markdown` syntax editing; | ||
35 | +3. Label management: CRUD label, label background color supports custom selection with `Vue-Color` plug-in; | ||
36 | +4. Message management: RD comments and replies; | ||
37 | + | ||
38 | +####Built With | ||
39 | + | ||
40 | + * [Node.js](https://nodejs.org/zh-cn/) | ||
41 | + * [Element-UI](https://element.eleme.cn/#/zh-CN) | ||
42 | + * [Webpack5](https://webpack.docschina.org/) | ||
43 | + * [MongoDB](https://www.mongodb.com/) | ||
44 | + * [Koa2](https://www.koajs.com.cn/) | ||
45 | + * [Vue2](https://cn.vuejs.org/) | ||
46 | + | ||
47 | +## **Getting Started** | ||
48 | + | ||
49 | +### **Prerequisites** |
-
Please register or login to post a comment