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!
- Multi Language Allows users to choose their preffered language.
- User Pages: Allows users to view their profiles and statistics.
- Login: Provides a secure authentication system for users to log in to their accounts.
- Beatmap Pages: Enables users to browse and view details of available beatmaps on this bancho.py instance.
- Leaderboards: Displays rankings of players based on various metrics.
- Register: Implementation of user registration functionality.
- User Settings: Allow users to customize their account settings and preferences.
- Beatmap Requests: Ability for users to request new beatmaps to be ranked/loved/approved.
- Admin Panel: A secure area for administrators to manage users, beatmaps, and system settings.
To get started with bpy-web, follow these steps:
-
Clone the Repository: Clone the bpy-web repository to your local machine using Git:
git clone https://github.com/HorizonCode/bpy-web.git -
Install Dependencies: Navigate into the project directory and install the necessary dependencies using npm:
cd bpy-web npm i -
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 -
Compile and run: Compile and start the frontend:
npm run compile -
Open in Browser: Once the development server is running, open your web browser and navigate to
http://localhost:3000to view the application.
We welcome contributions from the community to help improve bpy-web. If you'd like to contribute, please follow these guidelines:
- Fork the repository and create your branch from
main. - Make your contributions, ensuring adherence to coding standards and practices.
- Test your changes thoroughly.
- Submit a pull request detailing the changes you've made.
This project is licensed under the Apache License 2.0.