Skip to content

Commit 01a7b02

Browse files
authored
Update Docker Development readme (#470)
1 parent c31306c commit 01a7b02

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

docker/development/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
Here’s a cleaner and more polished version of your Hi.Events local development guide:
2+
3+
---
4+
5+
# Hi.Events local development with Docker
6+
7+
This guide walks you through setting up Hi.Events using Docker, including requirements, setup steps, configuration, and
8+
environment variables.
9+
10+
## Requirements
11+
12+
1. **Docker** – Required for containerized development. [Install Docker](https://docs.docker.com/get-docker/)
13+
2. **Git** – Needed to clone the
14+
repository. [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
15+
16+
> **Note:** This guide assumes a macOS or Linux environment. Windows users may need to adjust certain commands.
17+
18+
## Setup instructions
19+
20+
### 1. Clone the repository
21+
22+
Clone the Hi.Events GitHub repository:
23+
24+
```bash
25+
git clone [email protected]:HiEventsDev/Hi.Events.git
26+
```
27+
28+
### 2. Start the development environment
29+
30+
Navigate to the Docker development directory and run the startup script:
31+
32+
```bash
33+
cd Hi.Events/docker/development
34+
./start-dev.sh
35+
```
36+
37+
Once running, access the app at:
38+
39+
- **Frontend**: [https://localhost:8443](https://localhost:8443)
40+
41+
## Additional configuration
42+
43+
Hi.Events uses environment variables for configuration. You’ll find `.env` files in:
44+
45+
- `frontend/.env`
46+
- `backend/.env`
47+
48+
You can modify these to customize your setup.
49+
50+
For a full list of environment variables, see
51+
the [Environment Variables Documentation](https://hi.events/docs/getting-started/deploying#environment-variables).

0 commit comments

Comments
 (0)