Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation enhancement and typo fix #7

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Documentation enhancement and typo fix #7

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d13b87
updates readme with one more bullet point
aldotele Sep 29, 2022
1b85756
adds new line on step 2
aldotele Sep 29, 2022
7e13055
updates readme step 3
aldotele Sep 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ routes:
template: ./templates/user.tmpl
```

2) For each route, create a Golang `tmpl` file (named the same way you named it inside the configuration file):
2) For each route, create a Golang `tmpl` file (named the same way you named it inside the configuration file).\
For example, this would be our `article.tmpl`:

```html
<!DOCTYPE html>
Expand Down Expand Up @@ -84,11 +85,11 @@ routes:
</body>
</html>
```

3) Copy [this](/docker-compose.yaml) docker-compose file locally and run `docker-compose up -d`
4) Choose a title, an author and an image for your article opengraph image. Pass them via querystrng to the route you defined in your configuration file.
5) Go to `http://localhost:5491/articles/opengraph?author=Bojack%20Horseman&title=A%20Post%20About%20my%20Garden&imgUrl=https%3A%2F%2Fimages.unsplash.com%2Fphoto-1525498128493-380d1990a112%3Fixlib%3Drb-1.2.1%26ixid%3DeyJhcHBfaWQiOjEyMDd9%26auto%3Dformat%26fit%3Dcrop%26w%3D300%26q%3D80`
6) Admire the following image:
3) Don't forget to create a file called `.env` and place there your [Env Variables](#Env-Variables). In this case, port will be 5419, as specified in [this](/docker-compose.yaml) docker-compose file that we are going to use.
4) Now it's time to run on terminal `docker-compose up -d`.
5) Choose a title, an author and an image for your article opengraph image. Pass them via querystring to the route you defined in your configuration file.
6) Go to `http://localhost:5491/articles/opengraph?author=Bojack%20Horseman&title=A%20Post%20About%20my%20Garden&imgUrl=https%3A%2F%2Fimages.unsplash.com%2Fphoto-1525498128493-380d1990a112%3Fixlib%3Drb-1.2.1%26ixid%3DeyJhcHBfaWQiOjEyMDd9%26auto%3Dformat%26fit%3Dcrop%26w%3D300%26q%3D80`
7) Admire the following image:

<img src="/assets/example.jpeg" alt="Gauguin opengraph image example" />

Expand Down