Skip to content

Commit

Permalink
Merge pull request #44 from mondaycom/feature/romka/update-setup-readme
Browse files Browse the repository at this point in the history
update setup-api readme
  • Loading branch information
RomKadria authored Dec 4, 2024
2 parents 38a1f67 + 9cb8018 commit 9aaa9a0
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 17 additions & 9 deletions packages/setup-api/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Monday API Setup Library

**Important: This command works only in bash-like environments (e.g., macOS Terminal, iTerm, Linux shell, Git Bash on Windows). It is not compatible with Windows Command Prompt (cmd).**

## Installation

Run this command on the **root** directory of your project

```bash
npx @mondaydotcomorg/setup-api
```

## Overview

This library automates the setup of a development environment for working with the Monday API using GraphQL. It's designed to help developers quickly start projects with pre-configured tools and settings.
Expand Down Expand Up @@ -33,14 +43,6 @@ After everything will be set up, you should follow those steps:
2. Run 'npm run fetch:schma'
3. your types will be ready to use (as can be seen in the src/generated folder)

## Installation

Run this command on the **root** directory of your project

```bash
npx @mondaydotcomorg/setup-api
```

## Using the newly created scripts

After installation, you will have 3 new scripts:
Expand All @@ -49,12 +51,18 @@ After installation, you will have 3 new scripts:
- "codegen" - generates types
- "fetch:generate" - runs both

for now do the following to get the schema and create your first type.
To get the schema and create your first type run the following command:

```bash
npm run fetch:generate
```

Afterward, whenever you change your queries and want to recreate the types, you need to run:

```bash
npm run codegen
```

## Installing the GraphQL Extension for your IDE

### Visual Studio Code
Expand Down
2 changes: 1 addition & 1 deletion packages/setup-api/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mondaydotcomorg/setup-api",
"version": "1.3.1",
"version": "1.3.2",
"description": "monday.com setup api cli",
"main": "dist/cjs/index.js",
"types": "dist/cjs/index.d.ts",
Expand Down

0 comments on commit 9aaa9a0

Please sign in to comment.