Archived

This repository has been archived on 2025-08-19. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.

MD1125 f542df17ab Documentation & Formatting Changes

Co-Authored-By: svedev <28451791+svedev0@users.noreply.github.com>

2025-06-23 16:22:32 +02:00

1.5 KiB

Raw Blame History

Rugplay Website

This is the main website component of Rugplay, built with SvelteKit. It handles the user interface, trading functionality, and market visualization.

Development

Prerequisites

Node.js (LTS version)
Redis running in the background
OpenRouter API key (for AI features)
AWS S3/B2 Storage (for file uploads)

Environment Variables

Create a .env file based on .env.example:

cp .env.example .env

Key variables to configure:

PUBLIC_BETTER_AUTH_URL: Set to http://localhost:3002 if you want to deploy
OPENROUTER_API_KEY: Your OpenRouter API key for AI features
AWS credentials (optional but recommended)

Running in Development

npm install
npm run dev

The development server will be available at http://localhost:5173

Building for Production

npm run build
npm run preview

Project Structure

src/routes/: Page components and API endpoints
src/lib/: Shared components and utilities
src/lib/components/: Reusable UI components
static/: Static assets (images, fonts, etc.)

Features

User authentication and profile management
Real-time trading interface
Market visualization with Treemap
Leaderboards and statistics
Integration with websocket server for live updates

Contributing

Make sure Redis is running
Start the websocket server (see websocket/README.md)
Run the website in development mode
Make your changes
Test thoroughly
Submit a pull request

1.5 KiB Raw Blame History