Skip to content

Commit

Permalink
fix(config): fixes tsconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
csantiago132 committed Oct 22, 2024
1 parent 7f5f45b commit 583eeab
Show file tree
Hide file tree
Showing 17 changed files with 8,409 additions and 19,364 deletions.
2 changes: 1 addition & 1 deletion .github/actions/install/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ runs:
shell: bash
run: |
corepack enable
npm install --frozen-lockfile
pnpm install --frozen-lockfile
24 changes: 2 additions & 22 deletions Writerside/topics/Deploy-Workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,29 +44,9 @@ sequenceDiagram
DeployWorkflow-->>Runner: Deployment Successful
```

## Step 1 — Configure Necessary Secrets
## Step 1 — Create an app with Fly Launch

For the Deployment workflow to function correctly, certain secrets must be configured in your GitHub
repository settings. These secrets ensure secure access to necessary tools and services during the
workflow execution.

### a. Navigate to Repository Settings

1. Go to your repository on GitHub.
2. Click on the **Settings** tab.

### b. Access Secrets

1. In the left sidebar, click on **Secrets and variables** under the **Security** section.
2. Select **Actions** to manage secrets for GitHub Actions.

### c. Add Required Secrets

1. **FLY_API_TOKEN**:Your Fly.io API token for authenticating deployments.
2. **SENTRY_AUTH_TOKEN**: Your Sentry authentication token for integrating deployments with Sentry.
3. **Additional Secrets**: If your workflow requires access to other external services or APIs
(e.g., database credentials, API keys), add them here by clicking on New repository secret and
providing the necessary name and value.
Start by reading **[create an app with Fly Launch](https://fly.io/docs/launch/create/)**

## Step 2 — Create the Deployment Workflow File

Expand Down
11 changes: 6 additions & 5 deletions Writerside/topics/Guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ To complete this, you will need:
[How to Install Node.js and Create a Local Development Environment](https://www.digitalocean.com/community/tutorial_series/how-to-install-node-js-and-create-a-local-development-environment)
guide.
- A code editor like [Visual Studio Code](https://code.visualstudio.com/download)
- [PNPM installed](https://pnpm.io/installation)

## Initialize Your Project

Expand All @@ -18,7 +19,7 @@ yet, you can create one using the following commands:
```bash
mkdir my-project
cd my-project
npm init -y
pnpm init -y
```

You'll see the following output:
Expand All @@ -45,15 +46,15 @@ Wrote to /path/to/my-project/package.json:
### Install @kurocado-studio/style-guide

```Bash
npm install --save-dev @kurocado-studio/style-guide
pnpm install --save-dev @kurocado-studio/style-guide
```

[see @kurocado-studio/style-guide on NPM](https://www.npmjs.com/package/@kurocado-studio/style-guide)

### Install Husky

```Bash
npm install --save-dev husky
pnpm install --save-dev husky
```

### Next, enable Git hooks:
Expand All @@ -66,8 +67,8 @@ npx husky install

```json
"lint-staged": {
"*": "npm run prettier-fix",
"**/*.{ts,tsx}": ["npm run prettier-fix", "npm run eslint-check"]
"*": "pnpm run prettier-fix",
"**/*.{ts,tsx}": ["pnpm run prettier-fix", "pnpm run eslint-check"]
}
```

Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/How-To-Install-Commitlint.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
First, install Commitlint as a development dependency:

```bash
npm install --save-dev @commitlint/{config-conventional,cli}
pnpm install --save-dev @commitlint/{config-conventional,cli}
```

You’ll see output similar to:
Expand Down
6 changes: 3 additions & 3 deletions Writerside/topics/How-To-Install-ESLint.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Next, install ESLint as a development dependency:

```bash
npm install --save-dev eslint
pnpm install --save-dev eslint
```

You'll see output similar to:
Expand Down Expand Up @@ -85,7 +85,7 @@ CI/CD pipeline</note>
Run the lint script to analyze your code for issues:

```bash
npm run eslint-check
pnpm run eslint-check
```

You'll see output similar to:
Expand All @@ -100,7 +100,7 @@ You'll see output similar to:
To automatically fix fixable issues, run:

```bash
npm run eslint-fix
pnpm run eslint-fix
```

You'll see output similar to:
Expand Down
4 changes: 2 additions & 2 deletions Writerside/topics/How-To-Install-Prettier.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
install Prettier as a development dependency:

```bash
npm install --save-dev prettier
pnpm install --save-dev prettier
```

You'll see the following output:
Expand Down Expand Up @@ -66,7 +66,7 @@ This script tells Prettier to format all files within the `src` directory.
Run the format script to automatically format your code:

```bash
npm run prettier-fix
pnpm run prettier-fix
```

You'll see output similar to:
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/How-To-Install-Semantic-Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
## Step 1 — Install Semantic Release

```Bash
npm install --save-dev semantic-release
pnpm install --save-dev semantic-release
```

You’ll see output similar to:
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/How-To-Install-Typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
First, install TypeScript as a development dependency:

```Bash
npm install --save-dev typescript
pnpm install --save-dev typescript
```

You’ll see output similar to:
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/How-To-Install-Vitest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
## Step 1 — Install Vitest

```Bash
npm install --save-dev vitest @testing-library/react @testing-library/jest-dom @vitejs/plugin-react
pnpm install --save-dev vitest @testing-library/react @testing-library/jest-dom @vitejs/plugin-react
```

## Step 2 — Configure Vitest
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/starter-topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ development standards.
1. **Initial Setup:**

- Developer clones the repository.
- Installs necessary dependencies via NPM.
- Installs necessary dependencies via pnpm.

2. **Development Workflow:**
- Developer writes code adhering to the style guide.
Expand Down
Loading

0 comments on commit 583eeab

Please sign in to comment.