Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit d50c39b

Browse files
author
Renzo Lucioni
committed
Update README to make virtualenv use more clear
1 parent 8bbc7b9 commit d50c39b

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
@@ -23,36 +23,50 @@ All of the services can be run by following the steps below. Note that since we
2323
configure Docker with a sufficient amount of resources. Our testing found that [configuring Docker for Mac](https://docs.docker.com/docker-for-mac/#/advanced)
2424
with 2 CPUs and 4GB of memory works well.
2525

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
2741
a sibling of this directory. For example, if this repo is cloned to `~/workspace/devstack`, host volumes will be
2842
expected in `~/workspace/course-discovery`, `~/workspace/ecommerce`, etc. These repos can be cloned with the command
2943
below.
3044

31-
```
32-
$ make clone
33-
```
45+
```
46+
(devstack)$ make clone
47+
```
3448

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
3650
development without the auth service) and tenants (for multi-tenancy).
3751

3852
The username and password for the superusers are both "edx". You can access the services directly via Django admin
3953
at the `/admin/` path, or login via single sign-on at `/login/`.
4054

41-
```
42-
$ make devstack.provision
43-
```
55+
```
56+
(devstack)$ make devstack.provision
57+
```
4458

45-
3. Start the services.
59+
4. Start the services.
4660

4761
```
48-
$ make devstack.start
62+
(devstack)$ make devstack.start
4963
```
5064
5165
After the services have started, if you need shell access to one of the services, run `make devstack.open.<service>`.
5266
For example to access the Catalog/Course Discovery Service, you can run:
5367
5468
```
55-
$ make devstack.open.discovery
69+
(devstack)$ make devstack.open.discovery
5670
```
5771
5872
## Remaining Work

0 commit comments

Comments
 (0)