HorizonCode / bpy-web

bpy-web is a frontend web application developed using SvelteKit for the bancho.py backend by Akatsuki.
Apache License 2.0
4 stars 1 forks source link
bancho banchopy bpy frontend svelte sveltekit website

bpy-web

bpy-web is a frontend web application developed using SvelteKit for the bancho.py backend by Akatsuki.

[!WARNING] at current state, its not recommended to use bpy-web in a production environment!

Features

Getting Started

To get started with bpy-web, follow these steps:

  1. Clone the Repository: Clone the bpy-web repository to your local machine using Git:

    git clone https://github.com/HorizonCode/bpy-web.git
  2. Install Dependencies: Navigate into the project directory and install the necessary dependencies using npm:

    cd bpy-web
    npm i
  3. Configure .env: Copy the sample .env file to .env and configure it with the appropriate API endpoints and other settings:

    cp sample.env .env
    nano .env
  4. Compile and run: Compile and start the frontend:

    npm run compile
  5. Open in Browser: Once the development server is running, open your web browser and navigate to http://localhost:3000 to view the application.

Contributing

We welcome contributions from the community to help improve bpy-web. If you'd like to contribute, please follow these guidelines:

License

This project is licensed under the Apache License 2.0.