diff --git a/.vscode/extensions.json b/.vscode/extensions.json index daa2a0a..7dbab93 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -9,6 +9,7 @@ "yoavbls.pretty-ts-errors", "ms-playwright.playwright", "github.vscode-github-actions", - "lokalise.i18n-ally" + "lokalise.i18n-ally", + "ms-vscode-remote.remote-containers" ] } diff --git a/README.md b/README.md index d0451f5..fc57b72 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,13 @@ ## Getting Started 1. Clone the project: `git clone https://github.com/AirWalk-Digital/airview-next` -2. in VScode - "Open in Container" using remote containers. -3. Install dependencies: `npm i` -4. Run the dev server: `npm run dev` -5. Run storybook: `npm run storybook` +2. in VScode - "Open in Container" using remote containers [remote containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) + 2.1 Run `docker run -d --name redis -p 6379:6379 -p 8001:8001 redis/redis-stack:latest` to start redis container +3. Add required .env (see .env.example for content), github-app-private-key.pem, sharepoint-app-private-key.pem & .npmrc + 3.1 Access to aws portal is required to get the access keys from Secrets manger (.pem) +4. Install dependencies: `npm i` +5. Run the dev server: `npm run dev` +6. Run storybook: `npm run storybook` ### ✍️ Writing JSX