Skip to content

Commit 19b42bf

Browse files
committed
Add readme
1 parent 7b926b1 commit 19b42bf

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
1-
# Welcome to stack-exchange-graphql-server 👋
1+
# Welcome to stack-exchange-graphql-server
22
![Version](https://img.shields.io/badge/version-0.1.0-blue.svg?cacheSeconds=2592000)
33
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.md)
44

55
> GraphQL implementation to expose stack overflow resources (Comments, Posts, Answers, Votes, etc)
66
7-
[Stack Overflow](https://api.stackexchange.com/docs?tab=category#docs) doesn't have a GraphQL api...
7+
### 🏠 [Try out the live API](https://s11a.com)
88

9-
## Install
9+
[Stack Overflow](https://api.stackexchange.com/docs?tab=category#docs) doesn't have a GraphQL endpoint so I made one. For now, the live API above is in demo mode only. It is currently serving content from [https://anime.stackexchange.com/](https://anime.stackexchange.com/) and is updated weekly with more to come as the [pipeline & infra](https://github.com/snimmagadda1/stackexchange-dump-to-mysql) are beefed up & built out.
10+
11+
## Compile
1012

1113
```sh
12-
TODO
14+
go build server.go
1315
```
1416

1517
## Usage
18+
The endpoint is available as a docker container:
19+
```
20+
docker run snimmagadda/stack-exchange-graphql-server:latest
21+
```
22+
23+
or to run from source:
1624

1725
```sh
18-
TODO
26+
go run server.go
1927
```
2028

2129
## Run tests
@@ -24,6 +32,13 @@ TODO
2432
TODO
2533
```
2634

35+
## Built with
36+
- Go
37+
- [gqlgen](https://github.com/99designs/gqlgen)
38+
- [gorm](https://github.com/go-gorm/gorm)
39+
- [gqlparser](https://github.com/vektah/gqlparser)
40+
- [Azure](https://azure.microsoft.com/en-us/)
41+
2742
## Author
2843

2944
👤 **Sai Nimmagadda**

0 commit comments

Comments
 (0)