You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 1, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+25-11Lines changed: 25 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,36 +23,50 @@ All of the services can be run by following the steps below. Note that since we
23
23
configure Docker with a sufficient amount of resources. Our testing found that [configuring Docker for Mac](https://docs.docker.com/docker-for-mac/#/advanced)
24
24
with 2 CPUs and 4GB of memory works well.
25
25
26
-
1. The Docker Compose file mounts a host volume for each service's executing code. The host directory is expected to be
26
+
1. Create a Python 3 `virtualenv`. If you're using [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io
27
+
), you can do this with:
28
+
29
+
```
30
+
$ mkvirtualenv devstack --python=$(which python3)
31
+
```
32
+
33
+
Source the virtualenv and install requirements:
34
+
35
+
```
36
+
$ workon devstack
37
+
(devstack)$ make requirements
38
+
```
39
+
40
+
2. The Docker Compose file mounts a host volume for each service's executing code. The host directory is expected to be
27
41
a sibling of this directory. For example, if this repo is cloned to `~/workspace/devstack`, host volumes will be
28
42
expected in `~/workspace/course-discovery`, `~/workspace/ecommerce`, etc. These repos can be cloned with the command
29
43
below.
30
44
31
-
```
32
-
$ make clone
33
-
```
45
+
```
46
+
(devstack)$ make clone
47
+
```
34
48
35
-
2. Run the provision command, if you haven't already, to configure the various services with super-users (for
49
+
3. Run the provision command, if you haven't already, to configure the various services with super-users (for
36
50
development without the auth service) and tenants (for multi-tenancy).
37
51
38
52
The username and password for the superusers are both "edx". You can access the services directly via Django admin
39
53
at the `/admin/` path, or login via single sign-on at `/login/`.
40
54
41
-
```
42
-
$ make devstack.provision
43
-
```
55
+
```
56
+
(devstack)$ make devstack.provision
57
+
```
44
58
45
-
3. Start the services.
59
+
4. Start the services.
46
60
47
61
```
48
-
$ make devstack.start
62
+
(devstack)$ make devstack.start
49
63
```
50
64
51
65
After the services have started, if you need shell access to one of the services, run `make devstack.open.<service>`.
52
66
For example to access the Catalog/Course Discovery Service, you can run:
0 commit comments