Skip to content

Commit

Permalink
docs: install instructions (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
GabenGar authored Dec 10, 2024
1 parent 8b4c228 commit cc8e025
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 22 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,9 @@
# VSCode workspace file
*.code-workspace

# `turborepo prune` output
# https://turbo.build/repo/docs/reference/prune
/dist

# Dependency directories
node_modules/
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,33 @@
## Requrements
NodeJS - 20.9+

## Link Overwatch Extension
1. Clone the repo:
```sh
git clone https://github.com/GabenGar/todos.git
```
2. Switch to the repo:
```sh
cd ./todos
```
3. Create a [pruned output](https://turbo.build/repo/docs/reference/prune) for the extension package:
```sh
npx turbo prune "link-overwatch" --out-dir "./dist"
```
4. Switch into it
```sh
cd dist
```
5. Install dependencies:
```sh
npm install
```
6. Build extension:
```sh
npm run build
```
7. The extension archive will be located in `/apps/extension/dist`.

## Installation

1. Clone the repo:
Expand Down Expand Up @@ -38,7 +65,7 @@ NodeJS - 20.9+
## Develop

```sh
turbo dev
npm run dev
```

### Prep the Workflow
Expand Down Expand Up @@ -68,7 +95,7 @@ Turborepo claims that [the invocation from global install will invoke local inst
```sh
npm install turbo --global
```
And then instead of `npm run ...` commands it can be used as `turbo ...`.
And then instead of `npm run ...` commands it can be used as `turbo run ...`.

## Troubleshooting

Expand Down
20 changes: 0 additions & 20 deletions apps/extension/babel.config.js

This file was deleted.

0 comments on commit cc8e025

Please sign in to comment.