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

Commit d1d349c

Browse files
authored
Update README.md
1 parent 9476f06 commit d1d349c

File tree

1 file changed

+59
-60
lines changed

1 file changed

+59
-60
lines changed

README.md

Lines changed: 59 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,65 @@ Groot is the next generation web application serving the UIUC Chapter of ACM. It
3434

3535
- [groot-api-gateway](https://github.com/acm-uiuc/groot-api-gateway) - API Gateway for the Groot project written in Arbor
3636

37+
## Setting Up Groot
3738

38-
## Getting Started
39+
1. Follow [these](https://docs.docker.com/compose/install/#uninstallation) instructions to install Docker and docker-compose.
40+
2. Install repo - https://android.googlesource.com/tools/repo/
41+
42+
Mac OS
43+
```sh
44+
brew install repo
45+
```
46+
47+
Ubuntu 14.04+
48+
```sh
49+
sudo apt install repo
50+
51+
```
52+
3. Make a directory to house your groot work
53+
```sh
54+
mkdir groot-deploy
55+
```
56+
57+
4. Within this directory run the following command to start managing the projects
58+
59+
```sh
60+
repo init -u [email protected]:acm-uiuc/groot-manifest
61+
```
62+
63+
5. Run the following command to grab the latest releases of all services, including the frontend
64+
65+
```sh
66+
repo sync
67+
```
68+
69+
6. Run the settings init script:
70+
```sh
71+
./scripts/docker_settings_init.sh
72+
```
73+
7. Start up Docker. (This may involve `docker-machine` if you're on a Mac)
74+
8. Start the Docker containers:
75+
```sh
76+
docker-compose up
77+
```
78+
9. Wait for the image to build and startup. If it works, you'll be able to visit `https://0.0.0.0:5000` in a browser and see the deployed site. The Groot API will be available on port 8000.
79+
80+
Useful Notes:
81+
82+
* If you want to just rebuild one service (i.e. for dev work), you can keep the `docker-compose` command running, and run this command in a separate terminal window to rebuild the service you're working on:
83+
```
84+
docker-compose up -d --build SERVICE
85+
```
86+
* For dev work you'll probably want to run in unauthenticated mode. To do this, change the `CMD` line in `groot-api-gateway/Dockerfile` to:
87+
```
88+
CMD ["./build/groot-api-gateway", "-u"]
89+
```
90+
* To view logs, run:
91+
```
92+
sudo docker-compose logs -f
93+
```
94+
95+
## Legacy Instructions
3996
*Note: It is necessary for you to have an ssh key (without a password if you want it to be even easier) attached to your github*
4097

4198
1. Install repo - https://android.googlesource.com/tools/repo/
@@ -71,7 +128,7 @@ Groot is the next generation web application serving the UIUC Chapter of ACM. It
71128
5. Run the ```dev_spinup.sh``` script to start up a dev instance of groot (will grab the latest version of each service on github)
72129
6. Run the ```prod_spinup.sh``` script to start a production version of groot (will grab the latest version of each and place them in their respective containers, so you will need docker)
73130

74-
# First Time Setup
131+
### First Time Setup
75132
- Golang
76133
+ Install Software
77134
```sh
@@ -206,64 +263,6 @@ Groot is the next generation web application serving the UIUC Chapter of ACM. It
206263
mysql> CREATE DATABASE groot_quotes_service;
207264
```
208265

209-
## Deploying with Docker
210-
211-
1. Follow [these](https://docs.docker.com/compose/install/#uninstallation) instructions to install Docker and docker-compose.
212-
2. Install repo - https://android.googlesource.com/tools/repo/
213-
214-
Mac OS
215-
```sh
216-
brew install repo
217-
```
218-
219-
Ubuntu 14.04+
220-
```sh
221-
sudo apt install repo
222-
223-
```
224-
3. Make a directory to house your groot work
225-
```sh
226-
mkdir groot-deploy
227-
```
228-
229-
4. Within this directory run the following command to start managing the projects
230-
231-
```sh
232-
repo init -u [email protected]:acm-uiuc/groot-manifest
233-
```
234-
235-
5. Run the following command to grab the latest releases of all services, including the frontend
236-
237-
```sh
238-
repo sync
239-
```
240-
241-
6. Run the settings init script:
242-
```sh
243-
./scripts/docker_settings_init.sh
244-
```
245-
7. Start up Docker. (This may involve `docker-machine` if you're on a Mac)
246-
8. Start the Docker containers:
247-
```sh
248-
docker-compose up
249-
```
250-
9. Wait for the image to build and startup. If it works, you'll be able to visit `https://0.0.0.0:5000` in a browser and see the deployed site. The Groot API will be available on port 8000.
251-
252-
Useful Notes:
253-
254-
* If you want to just rebuild one service (i.e. for dev work), you can keep the `docker-compose` command running, and run this command in a separate terminal window to rebuild the service you're working on:
255-
```
256-
docker-compose up -d --build SERVICE
257-
```
258-
* For dev work you'll probably want to run in unauthenticated mode. To do this, change the `CMD` line in `groot-api-gateway/Dockerfile` to:
259-
```
260-
CMD ["./build/groot-api-gateway", "-u"]
261-
```
262-
* To view logs, run:
263-
```
264-
sudo docker-compose logs -f
265-
```
266-
267266
## License
268267

269268
This project is licensed under the University of Illinois/NCSA Open Source License. For a full copy of this license take a look at the LICENSE file.

0 commit comments

Comments
 (0)