Skip to content

Commit a421d13

Browse files
authored
Merge pull request #293 from ImaJin14/main
Re-arrange README.md file
2 parents 01c9e8b + cc99144 commit a421d13

File tree

1 file changed

+30
-32
lines changed

1 file changed

+30
-32
lines changed

README.md

+30-32
Original file line numberDiff line numberDiff line change
@@ -63,41 +63,39 @@ location.
6363

6464
Use the following instructions to start the project with Docker compose.
6565

66-
1. Initial Setup
67-
1. Ensure the [Data Repository](#data-repository), above, is in place
68-
2. Install Docker ([Install Docker Engine | Docker
69-
Documentation][installdocker])
70-
3. Create Django local settings file
71-
```
72-
cp cc_legal_tools/settings/local.example.py cc_legal_tools/settings/local.py
73-
```
74-
4. Build the containers
75-
```
76-
docker compose build
77-
```
78-
5. Run database migrations
79-
```
80-
docker compose exec app ./manage.py migrate
81-
```
82-
6. Clear data in the database
83-
```
84-
docker compose exec app ./manage.py clear_license_data
85-
```
86-
7. Load legacy HTML in the database
87-
```
88-
docker compose exec app ./manage.py load_html_files
89-
```
90-
2. Run the containers
66+
1. Ensure the [Data Repository](#data-repository), above, is in place
67+
2. Install Docker ([Install Docker Engine | Docker
68+
Documentation][installdocker])
69+
3. Create Django local settings file
70+
```
71+
cp cc_legal_tools/settings/local.example.py cc_legal_tools/settings/local.py
72+
```
73+
4. Build the containers
74+
```
75+
docker compose build
76+
```
77+
5. **Run the containers**
9178
```
9279
docker compose up
9380
```
94-
95-
The commands above will create two docker containers:
96-
1. **app** ([127.0.0.1:8005](http://127.0.0.1:8005/)): this Djano application
97-
- Any changes made to Python will be detected and rebuilt transparently as
98-
long as the development server is running.
99-
2. **static** ([127.0.0.1:8006](http://127.0.0.1:8006/)): a static web server
100-
serving [creativecommons/cc-legal-tools-data][repodata]/docs.
81+
1. **app** ([127.0.0.1:8005](http://127.0.0.1:8005/)): this Djano
82+
application
83+
- Any changes made to Python will be detected and rebuilt
84+
transparently as long as the development server is running.
85+
2. **static** ([127.0.0.1:8006](http://127.0.0.1:8006/)): a static web
86+
server serving [creativecommons/cc-legal-tools-data][repodata]/docs.
87+
6. Run database migrations
88+
```
89+
docker compose exec app ./manage.py migrate
90+
```
91+
7. Clear data in the database
92+
```
93+
docker compose exec app ./manage.py clear_license_data
94+
```
95+
8. Load legacy HTML in the database
96+
```
97+
docker compose exec app ./manage.py load_html_files
98+
```
10199
102100
[installdocker]: https://docs.docker.com/engine/install/
103101
[repodata]:https://github.com/creativecommons/cc-legal-tools-data

0 commit comments

Comments
 (0)