Restatic is a simple HTTP server that serves a local directory over HTTP. It is written in Go, and its usage is inspired by Python's http.server module.
To use Restatic, download the latest release for your platform and fire the following commands.
- Download the latest restatic/releases for your platform.
- Extract the binary from the just downloaded compressed artifact
- Execute the binary as shown in the following steps
$ ./restatic -p 5030 -d .
██████ ███████ ███████ ████████ █████ ████████ ██ ██████
██ ██ ██ ██ ██ ██ ██ ██ ██ ██
██████ █████ ███████ ██ ███████ ██ ██ ██
██ ██ ██ ██ ██ ██ ██ ██ ██ ██
██ ██ ███████ ███████ ██ ██ ██ ██ ██ ██████
by Relog - https://relog.in
INFO[0000] server listening on :5030
INFO[0000] =========================
- Browsing the URL on your favourite browser will load a webpage like this
If you are a developer and want to modify restatic, you will have first to set up a dev environment, and it has the following pre-requisites
Once you have set up all the pre-requisites, following the steps to start your development server.
- Clone the repository https://github.com/relogX/restatic
- Start the server
go run cmd/restatic/main.go
Once you start the server, it will download all the necessary packages and listen to the configured port. The default port is 5030.
Maintaining coding standards is extremely critical, and restatic follows the standard Gofmt to reformat the code. It is customary to fire the following command before you commit.
make lint
The Code Contribution Guidelines are published at CONTRIBUTING.md; please read them before you start making any changes. This would allow us to have a consistent standard of coding practices and developer experience.
Relog is an initiative that aims to transform engineering education and provide high-quality engineering courses, projects, and resources to the community. To better understand all the common systems, we aim to build our own replicated utilities, for example, a load balancer, static file server, API rate limiter, etc. All the projects fall under Apache License, Version 2.0, and you can find their source code at github.com/relogX.
Restatic is under Apache License, Version 2.0