Getting Started with ByteProxy
This guide will help you get ByteProxy up and running quickly.
Prerequisites
- Bun (recommended) or Node.js 18+
- Git
- Basic understanding of REST APIs
- API tokens for services you want to proxy (Discord, GitHub, etc.)
Installation
1. Clone the Repository
git clone https://github.com/ByteBrushStudios/ByteProxy.git
cd ByteProxy
2. Install Dependencies
# Using Bun (recommended)
bun install
# Using npm
npm install
3. Configure Environment
# Copy the example environment file
cp .env.example .env.local
# Edit with your preferred editor
nano .env.local
At minimum, configure:
PORT(default: 3420)- Service tokens:
DISCORD_BOT_TOKEN(if using Discord)GITHUB_TOKEN(if using GitHub)
4. Start the Server
# Development mode
bun run dev
# Production mode
bun run build
bun run start
Quick Verification
Once ByteProxy is running, check the following endpoints to verify it’s working correctly:
- Open http://localhost:3420 in your browser
- You should see the welcome message
- Visit the API Documentation
- This provides interactive Swagger documentation
- Check the Health Endpoint
- Should return
{"status":"ok",...}
- Should return
Making Your First Proxy Request
GitHub Example
# Get information about a GitHub user
curl http://localhost:3420/proxy/github/users/ByteBrushStudios
Discord Example
# Get information about your bot
curl http://localhost:3420/proxy/discord/users/@me
Next Steps
Now that you have ByteProxy running, you can:
- Explore the API: Use the Swagger Documentation
- Add Custom Services: See Adding Services
- Configure Authentication: See Security & Authentication
- Integrate with Your Application: Build frontends that use ByteProxy as a backend