https://github.com/lemoncloud-io/eurekakit-front
https://github.com/lemoncloud-io/eurekakit-front
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/lemoncloud-io/eurekakit-front
- Owner: lemoncloud-io
- License: other
- Created: 2025-04-03T02:08:33.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-05-27T04:03:28.000Z (about 1 year ago)
- Last Synced: 2025-05-27T05:19:01.299Z (about 1 year ago)
- Language: TypeScript
- Size: 1.22 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Build SNS services quickly and easily with EurekaKit.
[](https://github.com/lemoncloud-io)
[](https://nx.dev)
# π Getting Started with EurekaKit
1. Visit [EurekaCodes](https://eureka.codes/) to subscribe to the service
2. Create a workspace in the Eureka Code dashboard
3. Start development
## Features
**π§±All-In-One SNS Feed System**
- Post and Comment System: Support for various content formats including text, images, and videos
- Interaction Features: Various interaction options such as likes, shares, bookmarks, and reports for user engagement
- Customized Feed Algorithm: Personalized feeds based on user interests and activities
**π Infinite Scroll UI**
- Optimized Loading System: Provides a UX that naturally loads content as you scroll
- Performance Optimization: Optimized rendering system that smoothly processes large amounts of data
- Skeleton Loading: Skeleton UI that enhances user experience during content loading
**π Activity History Collection**
- Activity History: Record of all activities including feeds created, comments left, posts liked, etc.
- Viewing History: Feature to easily find recently viewed content
- Customized Summary: Provides statistics and summary information about your activities
**π Admin + App(WebView) Kit**
- Admin Dashboard: Complete administrative tools for user management, content moderation, service analysis, etc.
- React Native WebView App: Solution to quickly convert web services to mobile apps
- Cross-Platform Support: Consistent user experience across web, iOS, and Android
## Tech Stack
- Frontend Framework: React with TypeScript
- Project Structure: Nx Monorepo
- State Management: TanStack Query
- Styling: Tailwind CSS
- UI Components: Shadcn(Radix UI)
- API Integration: Axios
## Project Structure
```
eureka-kit
βββ apps/
β βββ admin/ # Admin main entry point
β βββ mobile/ # React Native WebView main entry point
β βββ web/ # Service main entry point
βββ assets/ # Project shared assets
βββ libs/
β βββ web-core/ # API authentication and initialization core library
β βββ comments/ # Comments related API library
β βββ feeds/ # Feeds related API library
β βββ users/ # Users related API library
β βββ uploads/ # Image upload related API library
β βββ app-checker/ # React Native WebView communication library
β βββ ui-kit/ # Common UI kit library
β βββ shared/ # Common utility library
β βββ types/ # Common type library
β βββ overlay/ # Overlay management library
β βββ theme/ # Theme management library
βββ scripts/ # Development scripts
βββ nx.json # nx configuration file
βββ package.json # Workspace package manager configuration file
```
## Getting Started
### Development Environment
- Node.js (v20 or higher)
- npm or yarn
- Git
- Android Studio or Xcode (for mobile app development)
### Installation
1. Clone the project
```bash
git clone https://github.com/lemoncloud-io/eurekakit-front.git
cd eurekakit-front
```
2. Install dependencies
```bash
yarn install
```
3. Environment variable setup
```bash
cp apps/web/.env.example apps/web/.env.local
cp apps/admin/.env.example apps/admin/.env.local
# Environment-specific setup (development, production, etc.)
# cp apps/web/.env.example apps/web/.env.(local|dev|prod|dev.local|...)
```
> - Q: Where are environment variables and required backend APIs provided?
> - A: Backend APIs can be obtained through the EurekaCodes platform. After subscribing and creating a workspace, you will receive dedicated API endpoints.
4. Run development server
```bash
# Run web service development server
yarn web:start
# Run mobile app development server (requires web server running first / simulator needed)
yarn mobile:start
# Run admin development server
yarn admin:start
```
> - Web service is accessible at http://localhost:5003
> - Admin service is accessible at http://localhost:5004
> - Mobile app runs on Android or iOS simulator and requires the web service to be running first.
## Contributing
We welcome contributions to EurekaKit! Please read our [contribution guidelines](CONTRIBUTING.md) for details on how to submit pull requests, the development process, and coding standards.
## License
EurekaKit is licensed under a proprietary license that restricts commercial usage to active EurekaCodes subscribers only. Public access to this repository is provided for evaluation purposes only.
For detailed license terms, please see the [LICENSE](LICENSE.md) file.
## Contributors β¨
Thanks goes to these wonderful people:
---
If this project has been helpful, please consider giving it a Star βοΈ!
Maintainer
- [@Luke](https://github.com/luke-lemon/)
- [@Louis](https://github.com/louis-lemon)
