aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 43052b9ceb0262379eb419d33dcbd7f1690e0003 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# Bare Server GO

- This is a complete bare server written in GO that is compliant with the [TompHTTP Server Specifications](https://github.com/tomphttp/specifications)

***NOTE: Unfinished*** *I skimmed the spec and wrote this only in a few hours. There are lots of unimplemented features and bugs. (and it's curtrently not very TOMP compatible)*
## Usage

### Prerequisites

- [GO](https://golang.org/doc/install)

### Installation

- Clone this repository
- To build run:
```bash
make all
```
- To run:
```bash
./bare-server-go start
```

### For more examples of usage see the [exaples](./examples) directory

#### Docker 

- To build AND run:
```bash
make docker
```

- To JUST build:
```bash
make docker-build
```

- To JUST run:
```bash
make docker-run
```

#### Docker Compose

- To build AND run:
```bash
make docker-compose
```

- To JUST build:
```bash
make docker-compose-build
```

- To JUST run:
```bash
make docker-compose-up
```

## Todo 

- [ ] V3 implementation
- [ ] Websocket Support - Partial support
- [x] CLI
- [ ] Other ways of installing (AUR, Bash, etc.)
- [ ] Other Ways of Handling Routes (net/http, gorilla/mux, etc.) CURRENTLY ONLY SUPPORTS: [chi](https://github.com/go-chi/chi)
- [ ] Installable in your own project
- [ ] Older versions of the spec