The Experience Labs' (XL) mission is to accelerate technical experience and build community among undergraduate CS majors at The University of North Carolina at Chapel Hill. The XL's web app, found in production at csxl.unc.edu, is backed by this repository.
Our sprint 0 aims to complete the story 6 of allowing users to view other users' posts. For the front end part, users can click the post_list tab on the left to view posts. For the back end part, we set the post_list page to "/api/post" For the database part, we put some inital post value in, and backend would fetch data from the database.
PS. We started on the create_post part, which corresponding to the story 4, but we have not finished that. So story 4 is not included in the sprint 0.
Our post so far include these elements:
id: int | None = None
title: str = ""
description: str = ""
content: str = ""
created: datetime = datetime.now()
postedBy: int | None # postedBy = userID
comments: list['Comment'] = [] # -->(we have not implement this part in Sprint 0)
tags: list[str] = []
title: str = ""
description: str = ""
For this sprint, we continue to improve the post feature and add a comment feature. Detailed documentation is in the docs folder. After logging in to the CSXL system, users will be redirected to the project list page. They could join the post forum by creating posts, search posts, and delete posts. Users could also interact with each other by commenting the posts. But currently, we completed the view comment and still needed to work on creating comments.
For Sprint 1 Expectations 1 & 2, we added documentation for features as below:
- Post Forum Feature
- Comment Feature And we added docstring as well
For Expectation 3: We complete the story of creating a post, which result in a change in the database. And registered CSXL user can create a post by typing in the information and click the button to make it public. Everyone can see the post.
For Expectation 4: For the admin-only story, we completed the story of deleting posts. Only the administrator and the author of a post are allowed to delete the post. We check for user permission in the backend. Only user with permission "post.delete" can execute the operation. In the frontend, users who do not have the permission to delete a certain post can not see a delete button, while users who have the permission (including admin) can see the button and click the button.
For Expectation 5: Other than the story we mentioned before, we also completed the story of searching posts. There is a search bar at the top of the page. Users can search for posts containing specific keywords. And all related posts would come out.
In sprint 2, we finalized all details on posts and comments. We also added detailed documentation and docstring. For Expectation 1: You can see our progress and management in the project tab. We tried to divide all the work in the project tab and linked them to corresponding PRs.
For Expectation 2: We changed the UI a lot to make it more asthetically appealing and more user friendly. Every feature is straightforward and has friendly error message.
For Expectation 3: We have a full set of CRUDS for post feasures for administrtors, and a set of CRD for comment features.
For Expectation 4: Our technical lead did not push any commit or merge any PRs during the sprint 2 (except for deployment because there was an error Kris helped us fix on technical lead's computer) The documentation for comment and post features are as detailed as possible for developers to understand.