Skip to content

Commit

Permalink
remove reference to running apps with gradle
Browse files Browse the repository at this point in the history
  • Loading branch information
cgardens committed Apr 8, 2021
1 parent 0a1cb94 commit ef1c11f
Showing 1 changed file with 0 additions and 48 deletions.
48 changes: 0 additions & 48 deletions docs/contributing-to-airbyte/developing-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,6 @@ VERSION=dev docker-compose up
./gradlew :airbyte-tests:acceptanceTests
```

## Develop on individual applications

The easiest way to develop on one of Airbyte's modules is to spin up the whole Airbyte system on your workstation, and shutdown the module you want to work on.

### Develop on `airbyte-webapp`

* Spin up Airbyte locally so the UI can make requests against the local API.
Expand All @@ -105,50 +101,6 @@ npm start

* Happy Hacking!

### Develop on `airbyte-server` \(APIs\)

* Spin up Airbyte locally.
* Stop the `server`.

```bash
docker-compose stop server
```

* Run the `server` with the command line. It will build and start a `server` with the current state of the code. You can also start the `server` from your IDE if you need to use a debugger.

```bash
./gradlew :airbyte-server:run
```

* Make sure everything is working by testing out a call to the API.

```bash
curl -H "Content-Type: application/json"\
-X POST localhost:8001/api/v1/workspaces/get\
-d '{ "workspaceId": "5ae6b09b-fdec-41af-aaf7-7d94cfc33ef6" }'
```

* Happy Hacking!

_Note: We namespace most API calls with a workspace id. For now there is only ever one workspace that is hardcoded to the id used in this example. If you ever need a workspace id, just use this one._

### Develop on `airbyte-scheduler`

* Spin up Airbyte locally.
* Stop the `scheduler`.

```bash
docker-compose stop scheduler
```

* Run the `scheduler` with the command line. It will build and start a `scheduler` with the current state of the code. You can also start the `scheduler`from your IDE if you need to use a debugger.

```bash
./gradlew :airbyte-scheduler:app:run
```

* Happy Hacking!

### Connector Specification Caching

The Configuration API caches connector specifications. This is done to avoid needing to run docker everytime one is needed in the UI. Without this caching, the UI crawls. If you update the specification of a connector and you need to clear this cache so the API / UI pick up the change. You have two options: 1. Go to the Admin page in the UI and update the version of the connector. Updating to the same version will for the cache to clear for that connector. 1. Restart the server
Expand Down

0 comments on commit ef1c11f

Please sign in to comment.