Skip to content

Commit

Permalink
Update README to make Docker Recommended way (alshedivat#1523)
Browse files Browse the repository at this point in the history
Docker is well-tested for a long time. I think it is better to make it
the recommended method for all OS types.

This way, it is a lot easier to install docker (than to install jekyll
and ruby and what not) and also we wouldn't have to deal with issues
like these:
- alshedivat#1520
- alshedivat#1491
  • Loading branch information
pourmand1376 authored and chertianser committed Aug 8, 2024
1 parent 6a53c90 commit ab95dcb
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,13 @@ Medical Robotics Junior Faculty Forum (ISMR: <a href="https://junior-forum-ismr.

## Table Of Contents

- [al-folio](#al-folio)
- [User community](#user-community)
- [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
- [Table Of Contents](#table-of-contents)
- [Getting started](#getting-started)
* [User community](#user-community)
* [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
* [Table Of Contents](#table-of-contents)
* [Getting started](#getting-started)
- [Installation](#installation)
- [Local setup using Docker (Recommended on Windows)](#local-setup-using-docker-recommended-on-windows)
- [Local Setup (Standard)](#local-setup-standard)
- [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
- [Local Setup (Legacy)](#local-setup-legacy)
- [Deployment](#deployment)
- [Upgrading from a previous version](#upgrading-from-a-previous-version)
- [FAQ](#faq)
Expand Down Expand Up @@ -204,18 +203,19 @@ $ cd <your-repo-name>

---

#### Local setup using Docker (Recommended on Windows)
#### Local setup using Docker (Recommended)
Using Docker to install Jekyll and Ruby dependencies is the easiest way.

You need to take the following steps to get `al-folio` up and running in your local machine:
You need to take the following steps to get `al-folio` up and running on your local machine:

- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
- Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.
- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website.

```bash
$ docker-compose up
```

Note that when you run it for the first time, it will download a docker image of size 300MB or so.
Note that when you run it for the first time, it will download a docker image of size 400MB or so.

Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, you can use the same command (`docker-compose up`) to render the webpage with all you changes. Also, make sure to commit your final changes.

Expand All @@ -237,7 +237,7 @@ $ docker-compose -f docker-local.yml up

---

#### Local Setup (Standard)
#### Local Setup (Legacy)

Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), and also [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) (*hint: for ease of managing python packages, consider using a virtual environment, like [venv](https://docs.python.org/pt-br/3/library/venv.html) or [conda](https://docs.conda.io/en/latest/). If you will use only `jupyter`, you can use [pipx](https://pypa.github.io/pipx/)*).

Expand Down

0 comments on commit ab95dcb

Please sign in to comment.