This project is essentially a revamp of the well-known surge.sh platform. While surge.sh is a fantastic tool for publishing web applications, I noticed it lacked certain features that could significantly enhance its utility. Therefore, I decided to create my own version, incorporating those missing elements to provide a more comprehensive and seamless user experience.
One key feature that it is self-hosted. This gives users more flexibility and control over their projects, allowing them to truly make their work their own. My goal with this project is to create a platform that not only meets but exceeds the needs of web developers, making the process of publishing web applications as hassle-free and efficient as possible. It also has some features that are not in surge.sh
**So saying shortly this is a simple web server for static websites but with an ability to deploy it with custom subdomain without any configuration using cli tool. On upload it will automatically create subdomain for your site.**
**This is a cli tool for upload [tool](https://github.com/clowzed/seroup)**
## 🚀 Features
- Deploy in seconds without configuration
- Enable and disable site `new`
- Download site `new`
- Limits control `new`
- Easy upload with cli tool
- Custom 404.html `(on 404 status user will see your 404.html)`
- Custom 503.html `new``(on disabled site)`
## 🔌 Built With
-`Rust`
-`Sea-orm` - [`sero is added to community examples`](https://github.com/SeaQL/sea-orm/blob/06c632712f3d167df0cda742dd228661b953ab7f/COMMUNITY.md?plain=1#L28)
-`Axum` - [`sero is added to community examples`](https://github.com/tokio-rs/axum/blob/d7258bf009194cf2f242694e673759d1dbf8cfc0/ECOSYSTEM.md?plain=1#L78)
Let see an example of uploading your site to your sero server.
Consider our domain is awesome.com
### Installing cli tool
```bash
npm i -g @clowzed/sero
```
### 🆕 Creating and initializing folder
```bash
mkdir our-website
cd our-website
sero init # This will generate default sero.toml file
```
### 🆕 Creating index.html
```bash
echo "Hello from our website!" > index.html
```
### 🔍 Inspecting `sero.toml`
Tha is how default sero.toml file looks like
```toml
[credentials]
username = "clowzed" # Here will be your hostname
password = ""
[server]
url = "http://sero.com/"
subdomain = "clowzed"
```
### ✏️ Changing `sero.toml`
So now we need to change url to point to our server.
We also want to change subdomain for our website
```toml
[credentials]
username = "clowzed"
password = ""
[server]
url = "http://awesome.com/"
subdomain = "oursite"
```
### ⬆️ Registration and uploading
```bash
sero register # We need to call it this only if we've changed username
sero upload
```
#### Now your site is available at [http://oursite.awesome.com/index.html]()
### Advanced usage with `new` features
1) Disabling site `new`
You can disable your site using this command.
```bash
sero disable
```
This will preserve your subdomain so other users will not be able to borrow it.
This will return `503 status code` for any request to site with your subdomain.
You can create `503.html` file so it will be returned to user. You can do it for maintenance. The `503.html` file should be at root of your folder
2) You can enable site with this command. Now it will work as usual. `new`
```bash
sero enable
```
3) Download your site `new`
You can easily download your site as zip with this command
```bash
sero download
```
4) Delete your site and free subdomain
```bash
sero teardown
```
## 📍 Roadmap
See the [open issues](https://github.com/ShaanCoding/ReadME-Generator/issues) for a list of proposed features (and known issues).
## 🧑🤝🧑 Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/ShaanCoding/ReadME-Generator/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
* Please make sure you check your spelling and grammar.
* Create individual PR for each suggestion.
* Please also read through the [Code Of Conduct](https://github.com/ShaanCoding/ReadME-Generator/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.