Skip to content

Commit f68b69b

Browse files
committed
Update README for prettier/docker usage
1 parent e057cce commit f68b69b

File tree

1 file changed

+8
-26
lines changed

1 file changed

+8
-26
lines changed

README.md

Lines changed: 8 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -67,39 +67,21 @@ For information on learning and installing the prerequisite technologies for thi
6767

6868
[found-tech]: https://opensource.creativecommons.org/contributing-code/foundational-tech/
6969

70-
### Docker Compose Setup
71-
72-
Use the following instructions to start the Project with docker compose.
73-
74-
1. Navigate to the creativecommons/chooser Project that you have cloned
75-
2. **Run the containers**
76-
77-
```shell
78-
docker compose up
79-
```
80-
81-
3. After running the above command, Docker will use the [`docker-compose.yml`](docker-compose.yml) file and build a local environment for you
82-
4. Navigate to http://localhost:8080 in your browser and the app would be running.
83-
5. **stop the containers**
84-
85-
To stop the app from running, simply open an another instance of terminal and type:
86-
87-
```shell
88-
docker compose down
89-
```
90-
91-
or
92-
93-
You can simply revisit the existing terminal which is running the container
94-
and type <kbd>CTRL</kbd> + <kbd>C</kbd>
95-
70+
1. open the `src/index.html` file within a browser to view the Chooser.
9671

9772
### Format with Prettier
9873

9974
Run the following command to format files with Prettier:
10075

10176
```shell
77+
docker compose run node prettier --write src/
78+
```
79+
80+
```shell
81+
## Or alternatively, if docker compose run is slow to run
82+
docker compose up --detach
10283
docker compose exec node prettier --write src/
84+
docker compose down
10385
```
10486

10587
## Structure

0 commit comments

Comments
 (0)