Skip to content

Commit 568977c

Browse files
committed
Updated readme
1 parent 6beff33 commit 568977c

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

README.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -150,45 +150,59 @@ Django-Appointment now supports Docker, making it easier to set up, develop, and
150150
you can quickly get the project running in a consistent environment, streamline the development process, and simplify
151151
deployment across different platforms.
152152

153-
### Getting Started with Docker
153+
### Getting Started with Docker for Development or Local Testing
154154

155-
To use Django-Appointment with Docker, follow these steps:
155+
Using Django-Appointment with Docker is primarily intended for development purposes or local testing. This means you'll
156+
need to clone the project from the GitHub repository to get started.
156157

157-
1. **Prepare .env File**: Create an `.env` file in the root directory of your project with your configuration settings.
158+
Here's how you can set up Django-Appointment for local development or testing with Docker:
159+
160+
1. **Clone the Repository**: Clone the Django-Appointment repository to your local machine:
161+
162+
```bash
163+
git clone https://github.com/adamspd/django-appointment.git
164+
```
165+
or using SSH:
166+
```bash
167+
git clone git@github.com:adamspd/django-appointment.git
168+
```
169+
170+
2. **Prepare .env File**: Create an `.env` file in the root directory of your project with your configuration settings.
158171
You should include your email host user and password for Django's email functionality:
159172

160173
```plaintext
161174
EMAIL_HOST_USER=your_email@gmail.com
162175
EMAIL_HOST_PASSWORD=your_password
163176
```
164-
2. **Build and Run the Docker Containers**: Run the following command to build and run the Docker containers:
177+
3. **Build and Run the Docker Containers**: Run the following command to build and run the Docker containers:
165178

166179
```bash
167180
docker-compose up -d --build
168181
```
169182

170-
3. **Create a Superuser**: After the containers are running, create a superuser to access the Django admin interface:
183+
4. **Create a Superuser**: After the containers are running, create a superuser to access the Django admin interface:
171184

172185
```bash
173186
docker-compose exec web python manage.py createsuperuser
174187
```
175188

176-
4. **Access the Application**: Once the containers are running, you can access the application at `localhost:8000`. The
189+
5. **Access the Application**: Once the containers are running, you can access the application at `localhost:8000`. The
177190
Django admin interface is available at `localhost:8000/admin`.
178-
5. **Shut Down the Containers**: When you're finished, you can shut down the containers with the following command:
191+
6. **Shut Down the Containers**: When you're finished, you can shut down the containers with the following command:
179192

180193
```bash
181194
docker-compose down
182195
```
183-
6. **(Optional) Run Migrations**: If you make changes to the models or database, you can run the migrations with the
196+
7. **(Optional) Run Migrations**: If you make changes to the models or database, you can run the migrations with the
184197
following command:
185198

186199
```bash
187200
docker-compose exec web python manage.py migrate
188201
```
189-
190-
> **Note:** I use the default database settings for the Docker container. If you want to use a different database, you can
191-
modify the Dockerfile and docker-compose.yml files to use your preferred database.
202+
203+
> **Note:** I use the default database settings for the Docker container. If you want to use a different database, you
204+
> can
205+
> modify the Dockerfile and docker-compose.yml files to use your preferred database.
192206

193207
## Customization 🔧
194208

0 commit comments

Comments
 (0)