Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kkkkkkkkatya authored Jun 7, 2024
1 parent 1e6d7c9 commit 93e5069
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Baryliuk.University.OnlineBookClub
Create a virtual space where book enthusiasts can discuss literature, join reading groups, and participate in author Q&A sessions.

To view the website: https://onlinebookclub.azurewebsites.net

## Author
Kateryna Baryliuk

Expand All @@ -16,96 +18,99 @@ https://t.me/@kkateerrina
That's all)

## Project Documentation
Add your project documentation here.

## Project Task Decomposition

### Project Task Decomposition
- User Registration: Users can register using their Google account via OAuth 2.0, ensuring a seamless and secure sign-up process.
- Welcome Email: Upon successful registration or first sign-in with Google Account, users receive a personalized welcome message in their email inbox, providing a warm introduction to the platform.
- Discussion Forums: Engage in vibrant discussions about various literary works, genres, and themes within dedicated discussion forums.
- Reading Groups: Join or create reading groups based on specific interests, allowing members to read and discuss books together in a communal setting.
- Author Q&A Sessions: Participate in live Q&A sessions with authors, providing an exclusive opportunity for users to interact directly with their favorite writers.
- User Profile Management: Users can manage their profiles, update personal information, and customize preferences to enhance their experience on the platform.
- Book Recommendations: Receive personalized book recommendations based on reading preferences and past interactions within the community.
- Admin Dashboard: Administrators have access to a dashboard for managing user accounts, moderating discussions, and organizing events.
- Feedback Mechanism: Users can provide feedback on books, discussions, and overall platform experience, helping to improve the community's quality and relevance.
- Reporting System: Report inappropriate content, spam, or abusive behavior to maintain a safe and welcoming environment for all members.



### Week 1:
#### Week 1:
- Implement feature: User Registration with Google OAuth 2.0 :heavy_check_mark:
- Set up Azure environment for project deployment :heavy_check_mark:
- Create README.md file with Getting Started documentation :heavy_check_mark:
- Develop basic front-end layout for landing page :heavy_check_mark:
- Set up Continuous Integration/Continuous Delivery pipeline :heavy_check_mark:

### Week 2:
#### Week 2:
- Implement feature: Welcome Email functionality :heavy_check_mark:
- Design database schema for user profiles and authentication :heavy_check_mark:
- Define API endpoints for user registration and authentication :heavy_check_mark:
- Integrate Google OAuth 2.0 for authentication :heavy_check_mark:
- Write unit tests for user authentication endpoints :heavy_check_mark:

### Week 3:
#### Week 3:
- Implement feature: Discussion Forums :heavy_check_mark:
- Develop front-end components for forum threads and replies :heavy_check_mark:
- Create RESTful API endpoints for forum CRUD operations :heavy_check_mark:
- Implement user authentication and authorization for forum access :heavy_check_mark:
- Conduct unit tests for forum functionality

### Week 4:
#### Week 4:
- Implement feature: Reading Groups :heavy_check_mark:
- Design database schema for reading groups and memberships :heavy_check_mark:
- Develop front-end interface for creating and joining reading groups :heavy_check_mark:
- Define API endpoints for managing reading groups :heavy_check_mark:
- Write unit tests for reading group functionalities

### Week 5:
#### Week 5:
- Implement feature: Author Q&A Sessions :heavy_check_mark:
- Set up infrastructure for hosting live Q&A sessions :heavy_check_mark:
- Develop front-end interface for scheduling and participating in Q&A sessions :heavy_check_mark:
- Define API endpoints for managing author sessions and user participation
- Conduct unit tests for Q&A session functionalities

### Week 6:
#### Week 6:
- Implement feature: User Profile Management :heavy_check_mark:
- Design database schema for user profiles and preferences :heavy_check_mark:
- Develop front-end interface for editing user profiles :heavy_check_mark:
- Define API endpoints for updating user information :heavy_check_mark:
- Write unit tests for user profile functionalities

### Week 7:
#### Week 7:
- Implement feature: Book Recommendations :heavy_check_mark:
- Integrate recommendation engine for personalized book suggestions :heavy_check_mark:
- Develop front-end component for displaying book recommendations :heavy_check_mark:
- Define API endpoints for retrieving recommended books based on user preferences :heavy_check_mark:
- Conduct unit tests for recommendation functionalities

### Week 8:
#### Week 8:
- Implement feature: Event Calendar
- Develop calendar component for displaying upcoming events
- Define API endpoints for fetching event data
- Integrate event notifications for user subscriptions
- Write unit tests for event calendar functionalities

### Week 9:
#### Week 9:
- Implement feature: Notification System
- Design real-time notification system for user interactions
- Develop front-end interface for displaying notifications
- Define API endpoints for managing notifications
- Conduct unit tests for notification functionalities

### Week 10:
#### Week 10:
- Implement feature: Admin Dashboard :heavy_check_mark:
- Design dashboard interface for administrative tasks :heavy_check_mark:
- Define admin roles and permissions :heavy_check_mark:
- Develop API endpoints for admin functionalities :heavy_check_mark:
- Write unit tests for admin dashboard functionalities

### Week 11:
#### Week 11:
- Implement feature: Feedback Mechanism :heavy_check_mark:
- Develop feedback form for user submissions :heavy_check_mark:
- Design database schema for storing feedback data :heavy_check_mark:
- Define API endpoints for collecting and processing feedback :heavy_check_mark:
- Conduct unit tests for feedback functionalities

### Week 12:
#### Week 12:
- Implement feature: Reporting System :heavy_check_mark:
- Develop reporting interface for users to flag inappropriate content :heavy_check_mark:
- Design database schema for storing reported content :heavy_check_mark:
Expand Down

0 comments on commit 93e5069

Please sign in to comment.