Skip to content

Commit 3f75eae

Browse files
committed
Update readme
1 parent 1703d4e commit 3f75eae

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ Hi.Events is designed to help you create, manage, and sell tickets for events of
6767

6868
## 🚀 Getting Started
6969

70-
For detailed installation instructions, please refer to our [documentation](https://hi.events/docs/getting-started). For a quick start, follow these steps:
70+
For detailed installation instructions, please refer to our [documentation](https://hi.events/docs/getting-started). For
71+
a quick start, follow these steps:
7172

7273
### One-Click Deployments
7374

@@ -77,9 +78,11 @@ For detailed installation instructions, please refer to our [documentation](http
7778

7879
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/8CGKmu?referralCode=KvSr11)
7980

80-
### 🐳 Local development - using Docker
81+
### 🐳 Quick Start with Docker
82+
8183
> [!IMPORTANT]
82-
> Please ensure you have Docker and Docker Compose installed on your system. If not, you can download them from the official Docker website: [Docker](https://www.docker.com/get-started).
84+
> Please ensure you have Docker and Docker Compose installed on your system. If not, you can download them from the
85+
> official Docker website: [Docker](https://www.docker.com/get-started).
8386
8487
1. **Clone the Repository:**
8588
```bash
@@ -88,21 +91,25 @@ For detailed installation instructions, please refer to our [documentation](http
8891

8992
2. **Navigate to the Docker Directory:**
9093
```bash
91-
cd hi.events/docker/development
94+
cd hi.events/docker/all-in-one
9295
```
9396

9497
3. **Run the set-up script:**
9598
```bash
96-
./start-dev.sh
99+
docker-compose up -d
97100
```
98101
4. **Create an account:**
99-
```
100-
Open your browser and navigate to https://localhost:8443/auth/register.
101-
```
102+
```bash
103+
Open your browser and navigate to https://localhost:8123/auth/register.
104+
```
105+
106+
ℹ️ Please refer to the [getting started guide](https://hi.events/docs/getting-started) for other installation methods, and
107+
for setting up a production or local development environment.
102108

103109
## 📝 Change Log
104110

105-
Stay updated with our ongoing improvements and feature additions at our [GitHub releases page](https://github.com/HiEventsDev/hi.events/releases).
111+
Stay updated with our ongoing improvements and feature additions at
112+
our [GitHub releases page](https://github.com/HiEventsDev/hi.events/releases).
106113

107114
## 🤝 Contributing
108115

@@ -111,10 +118,13 @@ please open an issue to discuss it.
111118

112119
## ❓ FAQ
113120

114-
Have questions? Our [Docs](https://hi.events/docs) have answers. If you can't find what you're looking for, feel free to reach out to us at [[email protected]](mailto:[email protected]).
121+
Have questions? Our [Docs](https://hi.events/docs) have answers. If you can't find what you're looking for, feel free to
122+
reach out to us at [[email protected]](mailto:[email protected]).
115123

116124
## 📜 License
117125

118-
Hi.Events is licensed under the terms of the [Elastic License 2.0](https://github.com/HiEventsDev/hi.events/blob/main/LICENCE), which means you can use it freely for commercial and non-commercial purposes, as long as you respect the terms of the license.
126+
Hi.Events is licensed under the terms of
127+
the [Elastic License 2.0](https://github.com/HiEventsDev/hi.events/blob/main/LICENCE), which means you can use it freely
128+
for commercial and non-commercial purposes, as long as you respect the terms of the license.
119129

120130
For more information on licensing, please visit our licensing page [here](https://hi.events/licensing).

0 commit comments

Comments
 (0)