You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The generation of usable JSON Web Tokens is available in [web-auth](https://gith
10
10
11
11
### REST API
12
12
13
-
-[ ] API for public website
13
+
-[ ] API for the public website
14
14
-[ ] VOD
15
15
-[x] Videos
16
16
-[x] Series
@@ -141,7 +141,7 @@ The generation of usable JSON Web Tokens is available in [web-auth](https://gith
141
141
142
142
### Setting up development database
143
143
144
-
You will need a PostgreSQL server running locally - either install it on your computer or use Docker.
144
+
You will need a PostgreSQL server running locally—either install it on your computer or use Docker.
145
145
146
146
Once you've done that, create a database to work with:
147
147
@@ -159,11 +159,12 @@ $ go run ./cmd/migrate-db
159
159
160
160
### Dev side note
161
161
162
-
If you are trying to connect to a database from your dev machine then I can recommend you use the following command to make your life easier.
162
+
If you are trying to connect to a database from your dev machine,
163
+
then I can recommend you use the following command to make your life easier.
163
164
164
165
`ssh -L [local port]:127.0.0.1:[db port on remote server] [remote server user and ip]`
165
166
166
-
This will prevent the full deploy being your dev environment and is much quicker.
167
+
This will prevent the full deployment being your dev environment and is much quicker.
167
168
168
169
### Static binary
169
170
@@ -196,7 +197,8 @@ Build the image.
196
197
197
198
`docker image build -t web-api .`
198
199
199
-
You will then need to set the environment variables like how it is set up in `docker-compose.yml` or you might be able to create a container and then use `docker export` so you can run a static binary built in docker.
200
+
You will then need to set the environment variables like how it is set up in `docker-compose.yml`
201
+
or you might be able to create a container and then use `docker export` so you can run a static binary built-in docker.
200
202
201
203
#### Docker-compose
202
204
@@ -209,7 +211,7 @@ Then fill in the docker-compose file with your credentials.
209
211
210
212
### Jenkins
211
213
212
-
Checkout this [document](ci.md).
214
+
Check out this [document](ci.md).
213
215
214
216
## Developing
215
217
@@ -244,7 +246,7 @@ Generate docs by running `go generate` in the root of the repo.
244
246
-`/services`
245
247
Internal API that is the main "business logic" for each service web-api provides.
246
248
-`/utils`
247
-
Provides access to commonly used functions, i.e. cdn, mq, sql
249
+
Provides access to commonly used functions, i.e. CDN, MQ, SQL
0 commit comments