Skip to content

Commit d9349fd

Browse files
authored
Merge pull request #123 from adamspd/fix/documentation
Update README.md
2 parents 7ec7088 + d4dfd52 commit d9349fd

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,11 @@ Here's how you can set it up:
170170
git clone [email protected]:adamspd/django-appointment.git
171171
```
172172

173+
then go to the project's directory:
174+
```bash
175+
cd django-appointment
176+
```
177+
173178
2. **Prepare an .env File**: Create an `.env` file in the root directory of your project with your configuration
174179
settings.
175180
You should include your email host user and password for Django's email functionality (if you want it to work):
@@ -187,24 +192,41 @@ Here's how you can set it up:
187192
docker-compose up -d --build
188193
```
189194

190-
4. **Create a Superuser**: After the containers are running, create a superuser to access the Django admin interface:
195+
or
196+
```bash
197+
docker compose up -d --build
198+
```
199+
200+
4. **Run Migrations**: Run the migrations with the following command:
201+
202+
```bash
203+
docker-compose exec web python manage.py migrate
204+
```
205+
206+
or
207+
```bash
208+
docker compose exec web python manage.py migrate
209+
```
210+
211+
5. **Create a Superuser**: After the containers are running, create a superuser to access the Django admin interface:
191212

192213
```bash
193214
docker-compose exec web python manage.py createsuperuser
194215
```
195216

196-
5. **Access the Application**: Once the containers are running, you can access the application at `localhost:8000`. The
197-
Django admin interface is available at `localhost:8000/admin`.
198-
6. **Shut Down the Containers**: When you're finished, you can shut down the containers with the following command:
199-
217+
or
200218
```bash
201-
docker-compose down
202-
```
203-
7. **(Optional) Run Migrations**: If you make changes to the models or database, you can run the migrations with the
204-
following command:
219+
docker compose exec web python manage.py createsuperuser
220+
```
221+
222+
6. **Access the Application**: Once the containers are running, you can access the application at `localhost:8000`. The
223+
Django admin interface is available at `localhost:8000/admin`. And from there, add the necessary configurations.
224+
[Follow this documentation](https://github.com/adamspd/django-appointment/blob/main/docs/explanation.md).
225+
7. **Shut Down the Containers**: When you're finished, you can shut down the containers with the following command:
205226
206227
```bash
207-
docker-compose exec web python manage.py migrate
228+
docker-compose down
229+
# docker compose down
208230
```
209231
210232
> **Note:** I used the default database settings for the Docker container.
@@ -249,4 +271,4 @@ I'm blocked on a few points.
249271

250272
## About the Author
251273

252-
Adams Pierre David - [Website](https://adamspierredavid.com/)
274+
Adams Pierre David - [Website](https://adamspierredavid.com/)

0 commit comments

Comments
 (0)