goplus / community Goto Github PK

View Code? Open in Web Editor NEW

9.0 2.0 15.0 57.46 MB

Go+ Community written in Go+

License: Apache License 2.0

Go 0.58% HTML 1.04% Vue 0.19% CSS 0.01% JavaScript 98.08% Dockerfile 0.01% Shell 0.01% Batchfile 0.01% Prolog 0.09%

community gop goplus

community's Introduction

Go+ Community written in Go+

🧳 Features

Go+ Community written in Go+ and Yap, support Go+ Community development.

🚀 How to run

Prepare golang and goplus environment.

golang version >= 1.19
- https://go.dev/dl/ (golang download, Find the golang 1.19 version)
goplus version == v1.2.0-pre.1
- Ref: https://github.com/goplus/gop/releases
- How to install goplus: https://github.com/goplus/gop#how-to-install

Prepare for your own config

Clone a file named .env from .env_temp in the cmd/gopcomm directory of the project.
Modify the .env file to your own configuration.

Run the project

Run the project with the following command:

gop run .

Open the browser and enter the address: http://localhost:8080 or GOP_COMMUNITY_ENDPOINT in your .env file.

📦 Contribute

Fork the repository to your local repo

Config code linter

// install pre-commit
pip install pre-commit

// config code linter in pre-commit hook
pre-commit install

Modify your own code
Commit your code
Create a pull request

Note: Please check the PR brach is mvp-20240119 or not.

community's People

Contributors

Stargazers

Watchers

Forkers

carlji xhyqaq ironicbo liuscraft wu-jj xushiwei baihhh motongxue visualfc kasey0727 nighca nnnnn319 huangsihao7 aofei

community's Issues

bug: display edit profile button when browsing someone else's page

This button should only be displayed after logging in and accessing one's own homepage

Peer Review

Article section

Optimize the front and back end paging logic of homepage 1 @Baihhh @Kasey0727
personal home page add edit and modify blog list 1 @Baihhh @Kasey0727
Search page optimization 1 @Baihhh @Kasey0727
Support visit history 2 @LiusCraft

Markdown editing

Modify markdown editing page, nested in gop community header and footer. 2 @nnnnn319
support compiling into html to support gop to display and run 2 @nnnnn319
markdown editor page design 1 @Kasey0727

User Interface

interact with the account subsystem, add the interface to get user information, and consider supporting rpc. 2 @IRONICBo @wu-jj
Support wechat login, and wechat share. @wu-jj @xhyqaq

Video Player Part

support video player embedding from media source, and add subtitle file logic 3 @xhyqaq

Yap framework

support yap middleware injection 1 @xhyqaq
yap middleware unified user processing, and security features 1 @IRONICBo @wu-jj
error page redirect, support automatic redirect to 5xx/2xx/4xx error page. @xhyqaq @Kasey0727
Update zap to xlog.

CI/CD processing

support code formatter in CI check.
test machine environment variable configuration support 1 @linjie7674

It seems that the yap framework does not support redirection methods

I need to redirect to the login page through the redirection function, but it seems that yap does not support this feature

Description

We need to set up the tasks and scheduling for each Task, each task need to be associated with one or multi PRs.

Peer Review

Task

Account & User Module - @wu-jj @xhyqaq

Implement account sdk in goplus community.
Implement uuid storage.
Implement article share.

Article Module - @Baihhh

Implement article creation, editing, and deletion functionality.
Article list view functionality.
Article details view functionality.
Support article translation with translation module. @IRONICBo

Markdown Support - @nnnnn319

Article editor supports Markdown syntax with cherry-markdown.
Save markdown preview functionality, save to QiNiu Object Storage or local storage. @Baihhh @xhyqaq
Support goplus highlight.
Support Video markdown tag. @IRONICBo @xhyqaq

Translation Functionality - @IRONICBo

Implement translation of markdown articles.
Implement batch translation in long text translation.
Support video to text.
Support text to audio.

Media Module - @xhyqaq

Users can upload and delete media files.
Media file display functionality.
Media file download functionality.

User Interface - @Kasey0727

Design and implement user interface in yap html.
Design and implement article interface in yap html.
Design and implement article list(home) interface in yap html.

Everyone is expected to complete their part by the end of this week, and submit their code and test reports. If you encounter any issues or need help during the development process, please raise it in the issue promptly.

Bug: Video bug list here

Media(Video/Images) will be fully loaded, we need to use page query to reduce request count.
Support load video with cover and video source.

Get video cover from frontend(@nnnnn319) or QiNiu storage?

UI: Better to have Image Preview for cover uploading

As following:

No cover preview even i have already uploaded the image.

enhance: The “translate” button on the Add Article Page is duplicated.

Markdown is only available as a component and does not require additional functionality.

Bug: Use default value or choose basic info in user page.

Support default value and choose basic property.

mysql-framework

enhance：back to top

home page： add a button to back to top.

Bug: Refactor url domain.

Refactor _yap.gox URL endpoint.

Reference:

https://www.oreilly.com/library/view/restful-web-services/9780596809140/ch04.html

https://docs.github.com/en/rest/about-the-rest-api/about-the-rest-api?apiVersion=2022-11-28

enhance: update favicon

We need to update a default goplus favicon.

casdoor facebook login error

bug: use bold text in markdown when adding article

enhance: Uneven spacing below the sharing button at the bottom of the article preview page

page:
https://hotst:port/p/59
https://hotst:port/p/52

bug: add article

bug: When adding acticle, the cover display has some proplem

bug: After adding an article successfully, there is a problem with the redirected page.

enhance: update article viewer page

We've updated the reading page, but it's a little strange to view at the moment.

Maybe we take a cue from Medium's style and bring user information and likes to the center of the page.

Code Coverage Fix

Code Coverage Collection
better to have 90%+ code coverage

Bug: Fix web style.

Update user info design.
Fix breadcrumb navigation.

Bug: bug list in MVP1

enhance：add article form validate

Although it is marked with a required *, it can be submitted if do not have any data.

enhance: Do not display when tag or cover image is empty

Bug: Problem with loading progress bar on search results page and home page

Enhance: Better to extract the first xxx characters of article Automatically

As following:

it's better to extract the first xxx characters of article Automatically.

Refer to Medium:

feature: Support peer review

Need to add collaborators to review code submissions and give pass comments.

When submitting PR, review request will be made to code owner, need to review and give LGTM comment, then @xushiwei teacher's side will give the next review comments, i.e., PRs need two reviews to enter merge session.

Ref: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Bug: unable click

As following:

UI: The icons seems too small, recommend to enlarge them

RT.

Task: PR Preview Environment Build

Refer: https://obr28bfkjv.feishu.cn/docx/QHcFdZL2LoyFGKxp16ec1fVbnJc

bug: Account issues in the online environment

Note: These bugs do not exist in the local environment.