Skip to content

Commit

Permalink
Adding a getting started doc page
Browse files Browse the repository at this point in the history
This allow the product to lower the entry level barrier

Signed-off-by: Juan Manuel Parrilla Madrid <[email protected]>
  • Loading branch information
jparrill committed Sep 30, 2023
1 parent a3fb075 commit f430881
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ All documentation is available in the [docs folder][documentation]. If you think

Shiori is distributed under the terms of the [MIT license][mit], which means you can use it and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request.

[getting started]: https://github.com/go-shiori/shiori/blob/master/docs/getting-started.md
[documentation]: https://github.com/go-shiori/shiori/blob/master/docs/index.md
[mit]: https://choosealicense.com/licenses/mit/
[web-extension]: https://github.com/go-shiori/shiori-web-ext
Expand Down
29 changes: 29 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Getting Started

In the beginning, it is necessary to execute the Shiori server locally. There are various methods available for this purpose; however, we will concentrate on employing the least intrusive option, which involves utilizing containers.

- Launch the Shiori server using the Command Line Interface (CLI):

```
mkdir -p ~/.config/shiori/
docker run -d -v ${HOME}/.config/shiori:/shiori -p 8080:8080 ghcr.io/go-shiori/shiori:latest
```

- Subsequently, you can access the homepage at the [here](http:/127.0.0.1:8080). Please use the following credentials to log in: `shiori/gopher.`

- Within the web application, you can add a new bookmark by following the steps depicted in the screenshots below:

![gs-01](./screenshots/17-gs-add-bookmark.png)
![gs-02](./screenshots/18-gs-add-bookmark.png)
![gs-03](./screenshots/19-gs-add-bookmark.png)

This action will generate a new entry, as illustrated in the final screenshot.

- Following this step, you should proceed to select the __Update Archive__ button in order to initiate the process of creating a local copy of the page.

![gs-04](./screenshots/20-gs-add-bookmark.png)
![gs-05](./screenshots/21-gs-add-bookmark.png)

- At this point, you will be able to observe your downloaded bookmark, which has been successfully stored locally.

![gs-06](./screenshots/22-gs-add-bookmark.png)
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Shiori is a simple bookmarks manager written in Go language. Intended as a simpl

## Resources

- [Getting Started](./Getting-Started.md)
- [API](./API.md) (Deprecated)
- [APIv1](./APIv1.md) ([What is this?](https://github.com/go-shiori/shiori/issues/640))
- [Contributing](./Contribute.md)
Expand Down
Binary file added docs/screenshots/17-gs-add-bookmark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/18-gs-add-bookmark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/19-gs-add-bookmark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/20-gs-add-bookmark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/21-gs-add-bookmark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/22-gs-add-bookmark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f430881

Please sign in to comment.