Skip to content

Commit baa2347

Browse files
committed
Merge branch 'master' of https://github.com/heydocode/ServerAPI
2 parents b4b7f33 + 9273dd2 commit baa2347

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

.github/workflows/rust.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Rust
2+
3+
on:
4+
push:
5+
branches: [ "master" ]
6+
pull_request:
7+
branches: [ "master" ]
8+
9+
env:
10+
CARGO_TERM_COLOR: always
11+
12+
jobs:
13+
build:
14+
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
- name: Build
20+
run: cargo build --verbose
21+
- name: Run tests
22+
run: cargo test --verbose

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# ServerAPI
2+
3+
ServerAPI is a versatile software that allows you to turn any machine (Windows, Linux, and macOS) into a server. It sends machine statistics via email, creates an online server management panel, and provides a console managed by user input and ServerAPI.
4+
5+
## Features
6+
7+
- Easy installation and setup
8+
- Sends machine statistics via email
9+
- Online server management panel
10+
- Console for server management
11+
- Supports running a Minecraft server with monitoring
12+
13+
## Requirements
14+
15+
- Access to Wi-Fi
16+
- A compatible device (iOS devices are not supported)
17+
18+
## Installation
19+
20+
1. Download and install the executable file.
21+
2. Launch the software.
22+
3. Follow the setup wizard.
23+
4. Enjoy using ServerAPI!
24+
25+
## Usage
26+
27+
To launch ServerAPI with the Minecraft server option, use the following command:
28+
```sh
29+
serverapi launch mc_server
30+
```
31+
This command will install the necessary files and launch the Minecraft server in parallel with mail and setup threads to monitor the server files for any errors.
32+
33+
## Configuration
34+
ServerAPI includes a setup wizard that guides the user through the necessary configuration steps. The user simply needs to answer the wizard's questions and confirm the provided information.
35+
36+
## Support
37+
For support, please create an "issue" on the GitHub page of the software.
38+
39+
## Contributing
40+
We welcome contributions! If you would like to contribute, please fork the repository and create a pull request. We are open to any suggestions for improvement.
41+
42+
## License
43+
This project is open-source and available under the MIT license. You are free to use, modify, and distribute the code as needed.
44+
45+
## Acknowledgments
46+
Special thanks to the Rust programming language community and the creators of the "lettre" Rust crate for making this project possible.

0 commit comments

Comments
 (0)