https://github.com/far-beyond-dev/horizon-api
The simplified publice version of the Horizon game server API. This can run on all non-enterprise Horizon Game server instances to allow external services to communicate with Horizon
https://github.com/far-beyond-dev/horizon-api
game-server integration rest-api rust socket-api socketio
Last synced: 3 months ago
JSON representation
The simplified publice version of the Horizon game server API. This can run on all non-enterprise Horizon Game server instances to allow external services to communicate with Horizon
- Host: GitHub
- URL: https://github.com/far-beyond-dev/horizon-api
- Owner: Far-Beyond-Dev
- Created: 2024-07-24T03:58:19.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T05:59:24.000Z (9 months ago)
- Last Synced: 2025-02-22T22:52:27.659Z (3 months ago)
- Topics: game-server, integration, rest-api, rust, socket-api, socketio
- Language: Rust
- Homepage: https://horizon.farbeyond.dev/
- Size: 235 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Horizon API
Horizon API is a simple RESTful API built using Rust. This API allows you to create new users and fetch user information based on their username.
## Features
- **Create User**: Register a new user with a username and password.
- **Get User**: Retrieve user information by username.
## Getting Started
### Setup
1. **Clone the repository**:
```sh
git clone https://github.com/Stars-Beyond/horizon-api.git
cd horizon-api
```
2. **Setup the database**:
Run Diesel migrations to set up the database schema.
```sh
mv ./.env.example ./.env
```
### Running the API
To start the Rocket server, run:
```sh
cargo run
```
The server will be running at `http://localhost:8000`.