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.

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

Update Readme.md #10132

Closed
Changes from all commits
Commits
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
23 changes: 21 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,29 @@ Here's a quick public tour of Open Library to get you familiar with the service
- [The Vision (Dream) of OpenLibrary](https://openlibrary.org/about/vision)
- [Visit the Blog](https://blog.openlibrary.org)

## Installation
### Installations

Run `docker compose up` and visit http://localhost:8080
---

Install Docker form [here](https://www.docker.com/products/docker-desktop/) and once its installed run below code in bash to check if its installed correctly:

```bash
docker --version
```

Once, docker is installed, go ahead and fork this repo form [here](https://github.com/internetarchive/openlibrary/fork) and then clone it to your local machine.

```bash
git clone https://github.com/<your-github-username>/<name-of-forked-repo>.git
```

it might take a few seconds to clone, once its done run this in terminal

```bash
docker compose up
```

and the installation would start at [http://localhost:8080](http://localhost:8080/)
Need more details? Checkout the [Docker instructions](https://github.com/internetarchive/openlibrary/blob/master/docker/README.md)
or [video tutorial](https://archive.org/embed/openlibrary-developer-docs/openlibrary-docker-set-up.mp4).

Expand Down
Loading