diff options
| author | Blaster4385 <blaster4385@tablaster.dev> | 2024-02-20 17:37:14 +0530 |
|---|---|---|
| committer | Blaster4385 <blaster4385@tablaster.dev> | 2024-04-30 11:10:37 +0530 |
| commit | b8dffc41e6a31da2a30e91f98358228fabf8ca75 (patch) | |
| tree | 49bc6c4e89a0d454ea42cc73dd831ae283f9045e | |
| parent | 4754f4a0c0135af6cb36a6dda68203026058f58f (diff) | |
chore: updated readme
| -rw-r--r-- | README.md | 35 |
1 files changed, 7 insertions, 28 deletions
@@ -17,28 +17,20 @@ This is a simple code sharing service and a URL shortener inspired by [katbin](h - [Go](https://go.dev/) - [SQLite](https://www.sqlite.org/) -## Setup - -### Client - -#### Install dependencies +## Building +- Setup the required variables in the env file. +- Build the binary ```bash -bun install +make minibin ``` -#### Run a development server - -```bash -bun dev -``` +#### Running -### Server - -#### Run a development server +Run the server. ```bash -go run . +./minibin ``` ##### Optional flags @@ -46,19 +38,6 @@ go run . - `--port` - The port to run the server on. Default is 8080. - `--db` - The path to the database file. Default is `./minibin.db`. -#### Run a production server - -Build a binary. - -```bash -go build -``` -Run the server. - -```bash -./minibin -``` - ## License This project is licensed under the GNU General Public License v3. See the LICENSE file for details. |