Project_Novel is a comprehensive web application designed for reading novels, supporting premium features, user posting, author management, and statistical analysis. The project follows a microservices architecture for scalability, modularity, and maintainability.
- MySQL 8.0 - Relational database for structured data.
- MongoDB - NoSQL database for flexible and unstructured data.
- Elasticsearch 8.2.0 - Full-text search engine for efficient search functionality.
- JDK 21 - Java Development Kit for backend development.
- Maven 3.8 - Build and dependency management tool.
- Node.js 18 - Runtime environment for server-side JavaScript.
- IntelliJ IDEA - Backend development.
- Visual Studio Code - Frontend development.
| Technology | Version | Description |
|---|---|---|
| Spring Boot | 3.0.0 | Container + MVC Framework |
| JWT | 0.11.5 | JSON Web Token support for authentication |
| Lombok | 1.18.24 | Simplifies object encapsulation and reduces boilerplate code |
| MySQL | 8.0 | Relational database for structured data |
| Elasticsearch | 8.2.0 | Full-text search engine for fast and efficient queries |
| Docker | - | Application containerization for deployment |
| MongoDB | - | NoSQL database for storing unstructured data |
| Kafka | 3.0.0 | Distributed event streaming platform for building real-time data pipelines and streaming applications |
| OAuth2 | 3.0.0 | Authorization framework that enables applications to obtain limited access to user accounts on an HTTP service |
- Independent Services: Each functionality (authentication, search, statistics, etc.) is developed and deployed independently.
- Scalability: Services can be scaled based on load.
- Resilience: Failures in one service do not impact others.
| Technology | Version | Description |
|---|---|---|
| Vue.js | 3.2.13 | Progressive JavaScript framework for building user interfaces |
| Vue Router | 4.0.15 | Official routing library for Vue.js |
| Axios | 0.27.2 | Promise-based HTTP client for API communication |
| TailwindCSS | 2.2.0 | Utility-first CSS framework for styling |
| Vite | 2.7.13 | Build tool that aims to provide a faster and leaner development experience for modern web projects |
| FontAwesome | 6.0.0 | Icon library for scalable vector icons |
| Tiptap | 2.0.0 | Headless, framework-agnostic text editor |
| vue3-draggable-next | A Vue 3 component for draggable elements, providing a simple and flexible way to create drag-and-drop interfaces. | |
| vuex | A state management pattern + library for Vue.js applications, enabling centralized state management with a single source of truth. |
- Novel Reading: Supports free and premium chapters with a seamless reading experience.
- User Management: Registration, login, and role-based access control (Reader, Author, Admin).
- Author Dashboard: Tools for authors to manage their novels, chapters, and earnings.
- Content Management: Users can post and manage their content.
- Advanced Search: Elasticsearch-powered search for novels, authors, and chapters.
- Analytics and Statistics: Admins can view user engagement, top novels, and revenue trends.
- Microservices: Each feature is implemented as an independent service for better scalability.
- Clone Repository:
git clone https://github.com/yourusername/project_novel.git cd project_novel
- Install JDK 21, Maven 3.8, and Docker.
- Configure database credentials in
application.yaml. - Build and run services:
mvn clean install docker-compose up
- Install Node.js 18 and dependencies:
cd frontend npm install npm run dev
- Visit http://localhost:8888 for the backend.
- Visit http://localhost:5173 and http://localhost:5174 for the frontend.
- Kotlin app
- Base UI : 70%
- Personalized recommendations
- Collaborative filtering
- Content-based filtering
- User profiles
- Follow system
- Commenting system
- Likes and ratings
- Activity feed
- User authentication system
- Send email functionality
- OAuth2 integration
- Read novel feature
- Write novel service
- Pay-per-chapter system
- Novel categories
- Upload Image
- Setup for reading novels settings
- Post service
- Post management system
- Post categories
- Post tags
- Search system
- Advanced search system
- Search settings
- Search filters
- Search categories
- Search by author
- Search by tags
- Author dashboard
- Earnings and revenue system
- Author statistics
- Author profile
- Author settings
- Author notifications
- Author payment system
- Admin dashboard
- User management
- Novel management
- Post management
- Revenue management
- Analytics and statistics
- Payment system
- Notification system
- Settings
- User roles
- User permissions
- Notification system
- Email notifications
- In-app notifications
- Push notifications
- Notification settings
- Notification management
---TO BE COUNTINUED---