Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

modify dev instructions to require docker #1183

Merged
merged 1 commit into from
May 20, 2024
Merged

modify dev instructions to require docker #1183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Have the following installed first:
1. [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html#getting-started-install-instructions)
1. [VSCode](https://code.visualstudio.com/)
1. [git](https://git-scm.com/downloads)
1. [Docker Desktop](https://docs.docker.com/get-docker/)

### Recommended

Expand All @@ -31,7 +32,6 @@ Have the following installed first:
1. [Postman](https://www.postman.com/downloads/) - Extremely helpful for testing REST APIs
1. [Chrome](https://www.google.com/chrome/) - For Chrome developer tools
1. [Redux Devtools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) - Helpful for debugging any Redux
1. [Docker](https://docs.docker.com/engine/install/) - For Docker images
1. [go](https://go.dev/doc/install) - In case if you ever need to contribute to the dlp-cli
1. VSCode Extensions:
1. [Github Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
Expand Down Expand Up @@ -67,12 +67,13 @@ git clone https://github.com/DSGT-DLP/dlp-practice.git

## 3. Frontend and Backend Package Installation

Run the following commands in the project directory (the root folder created after cloning):
Run the following command in the project directory (the root folder created after cloning):

| Action | Command |
| -------------------------------- | -------------------------- |
| Install/Update Frontend Packages | `dlp-cli frontend install` |
| Install/Update Backend Packages | `dlp-cli backend install` |

It's no longer necessary to install the backend, as the dependencies will be automatically installed when running `dlp-cli backend start`.

## 4. To start on localhost

Expand Down
2 changes: 1 addition & 1 deletion training/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ services:
- ./:/home/app/training
- $HOME/.aws:/home/app/.aws:ro
ports:
- 8000:8000
- ${BACKEND_PORT:-8000}:8000
environment:
- AWS_PROFILE=$AWS_PROFILE
depends_on:
Expand Down
Loading