Skip to content
Merged
Show file tree
Hide file tree
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
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ Install docker on your system first. If you already have docker installed, you c

## Quickstart

### 0) Default Layout

```
project-root/
├─ application/
│ ├─ site1/
│ ├─ site2/
│ └─ ...
└─ LocalDevStack/ (this repository)
```

This layout is flexible. If you want a different projects folder, set `PROJECT_DIR` in your env.

```bash
# supports relative/absolute path (recommended to use absolute path for less confusion)
PROJECT_DIR=/path/to/your/projects
```

### 1) Clone
```bash
git clone https://github.com/infocyph/LocalDevStack.git
Expand Down
18 changes: 9 additions & 9 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,6 @@ Quick Start

- :doc:`guides/tls-and-certificates`

Next steps
----------

- Domain and vhosts: :doc:`guides/domain-setup`
- Local TLS (mkcert + certify): :doc:`guides/tls-and-certificates`
- Node apps behind Nginx: :doc:`guides/node-apps`
- Encrypted secrets (SOPS + Age): :doc:`guides/secrets-sops-age`
- Notifications: :doc:`guides/notifications`

Directory Structure
-------------------

Expand Down Expand Up @@ -135,3 +126,12 @@ Shells::
Notes:

- ``lds core <domain>`` is intended to open the right runtime container shell for that domain.

Next steps
----------

- Domain and vhosts: :doc:`guides/domain-setup`
- Local TLS (mkcert + certify): :doc:`guides/tls-and-certificates`
- Node apps behind Nginx: :doc:`guides/node-apps`
- Encrypted secrets (SOPS + Age): :doc:`guides/secrets-sops-age`
- Notifications: :doc:`guides/notifications`