{"id":49727008,"url":"https://github.com/maugus0/yushan-platform-frontend","last_synced_at":"2026-05-09T05:04:03.940Z","repository":{"id":320421645,"uuid":"1081579833","full_name":"maugus0/yushan-platform-frontend","owner":"maugus0","description":"Frontend application for Yushan Platform - A gamified web novel reading platform built with React and Create React App.","archived":false,"fork":false,"pushed_at":"2026-02-12T21:26:23.000Z","size":15311,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-19T00:52:29.119Z","etag":null,"topics":["create-react-app","frontend","gamification-platform","javascript","jest","reactjs","responsive-design"],"latest_commit_sha":null,"homepage":"https://maugus0.github.io/yushan-platform-frontend/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maugus0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-23T01:35:12.000Z","updated_at":"2025-12-27T10:07:43.000Z","dependencies_parsed_at":"2025-10-23T18:36:53.719Z","dependency_job_id":null,"html_url":"https://github.com/maugus0/yushan-platform-frontend","commit_stats":null,"previous_names":["maugus0/yushan-platform-frontend"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/maugus0/yushan-platform-frontend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maugus0%2Fyushan-platform-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maugus0%2Fyushan-platform-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maugus0%2Fyushan-platform-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maugus0%2Fyushan-platform-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maugus0","download_url":"https://codeload.github.com/maugus0/yushan-platform-frontend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maugus0%2Fyushan-platform-frontend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32807861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["create-react-app","frontend","gamification-platform","javascript","jest","reactjs","responsive-design"],"created_at":"2026-05-09T05:03:56.508Z","updated_at":"2026-05-09T05:04:03.935Z","avatar_url":"https://github.com/maugus0.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yushan Platform Frontend\n\n\u003e 🌟 **Frontend application for Yushan Platform** - A gamified web novel reading platform that transforms reading into an engaging, social experience.\n\n## 🚀 Tech Stack\n\n- **Framework**: React 18+\n- **Build Tool**: Create React App\n- **Language**: JavaScript/TypeScript\n- **Styling**: CSS Modules / Styled Components\n- **State Management**: Context API / Redux (planned)\n- **HTTP Client**: Axios\n- **Testing**: Jest, React Testing Library\n\n## ✨ Key Features\n\n### 📖 Core Platform\n\n- Interactive novel reading interface\n- User authentication and registration\n- Novel discovery and search\n- Reading progress tracking\n- Bookmarks and favorites management\n\n### 🎮 Gamification UI\n\n- XP and level progress displays\n- Achievement badges and notifications\n- Reading streak counters\n- Leaderboard rankings\n- Social interaction components\n\n### 🔧 Technical Features\n\n- Responsive design for all devices\n- Component-based architecture\n- API integration with backend\n- Real-time updates\n- Progressive Web App capabilities\n- Performance optimized builds\n\n## 🏗️ Project Structure\n\n```\nsrc/\n├── components/          # Reusable UI components\n│   ├── common/         # Shared components (Button, Modal, etc.)\n│   ├── novel/          # Novel-related components\n│   └── user/           # User interface components\n├── pages/              # Route-based page components\n│   ├── Home.js         # Landing page\n│   ├── Login.js        # Authentication\n│   ├── Novel.js        # Novel reading page\n│   └── Profile.js      # User profile\n├── services/           # API integration layer\n│   ├── api.js          # Base API configuration\n│   ├── novelService.js # Novel-related API calls\n│   └── userService.js  # User-related API calls\n├── utils/              # Utility functions\n├── hooks/              # Custom React hooks\n├── context/            # React Context providers\n└── assets/             # Static assets (images, fonts)\n```\n\n## 🚦 Getting Started\n\n### Prerequisites\n\n- Node.js 16+\n- npm 8+ or yarn\n- Yushan Microservices running (for full functionality)\n\n### Quick Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/maugus0/yushan-platform-frontend.git\ncd yushan-frontend\n\n# Install dependencies\nnpm install\n\n# Start development server\nnpm start\n```\n\nOpen [http://localhost:3000](http://localhost:3000) to view it in your browser.\n\n### Environment Configuration\n\nCreate a `.env` file in the root directory:\n\n```env\nREACT_APP_API_BASE_URL=http://localhost:8080/api\nREACT_APP_APP_NAME=Yushan\n```\n\n## 📜 Available Scripts\n\n### `npm start`\n\nRuns the app in development mode. The page will reload when you make changes.\n\n### `npm test`\n\nLaunches the test runner in interactive watch mode.\n\n### `npm run build`\n\nBuilds the app for production to the `build` folder. Optimized and minified for deployment.\n\n### `npm run eject`\n\n⚠️ **One-way operation!** Ejects from Create React App for full configuration control.\n\n## 🧪 Development\n\n### Component Development\n\n```bash\n# Create new component\nmkdir src/components/ComponentName\ntouch src/components/ComponentName/ComponentName.js\ntouch src/components/ComponentName/ComponentName.css\ntouch src/components/ComponentName/index.js\n```\n\n### Testing\n\n```bash\n# Run all tests\nnpm test\n\n# Run tests with coverage\nnpm test -- --coverage\n```\n\n### Code Quality\n\n```bash\n# Lint code\nnpm run lint\n\n# Format code\nnpm run format\n```\n\n## 🎨 UI/UX Features\n\n- **Novel Reader**: Immersive reading experience with customizable themes\n- **Progress Tracking**: Visual progress bars and reading statistics\n- **Gamification Elements**: XP bars, achievement popups, streak counters\n- **Responsive Design**: Optimized for desktop, tablet, and mobile\n- **Dark/Light Mode**: Theme switching for comfortable reading\n- **Accessibility**: WCAG compliant components\n\n## 🔗 API Integration\n\nThe frontend connects to the Yushan Backend API:\n\n- Authentication endpoints\n- Novel and chapter management\n- User progress tracking\n- Gamification features\n- Social interactions\n\n## 📱 Deployment\n\n### Development\n\n```bash\nnpm start\n```\n\n### Production Build\n\n```bash\nnpm run build\n# Deploy the 'build' folder to your hosting service\n```\n\n## 🛠️ Built With\n\n- [React](https://reactjs.org/) - Frontend framework\n- [Create React App](https://create-react-app.dev/) - Build toolchain\n- [React Router](https://reactrouter.com/) - Client-side routing\n- [Axios](https://axios-http.com/) - HTTP client\n- [React Testing Library](https://testing-library.com/react) - Testing utilities\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n### Development Guidelines\n\n- Follow React best practices\n- Write tests for new components\n- Maintain consistent code style\n- Update documentation for new features\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 📚 Learn More\n\n- [Create React App Documentation](https://facebook.github.io/create-react-app/docs/getting-started)\n- [React Documentation](https://reactjs.org/)\n- [Deployment Guide](https://facebook.github.io/create-react-app/docs/deployment)\n\n---\n\n**Yushan Platform Frontend** - Bringing gamified reading to life 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaugus0%2Fyushan-platform-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaugus0%2Fyushan-platform-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaugus0%2Fyushan-platform-frontend/lists"}