Skip to content

Commit 7e25670

Browse files
authored
Update README setup instructions (#427)
* Update README setup instructions * fix
1 parent dda78d3 commit 7e25670

File tree

1 file changed

+37
-29
lines changed

1 file changed

+37
-29
lines changed

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,54 @@
11
# Launchpad
22

3-
A microservice for analyzing iOS and Android apps.
3+
A service for analyzing iOS and Android apps.
44

55
[![codecov](https://codecov.io/gh/getsentry/launchpad/graph/badge.svg?token=iF5K92yaUu)](https://codecov.io/gh/getsentry/launchpad)
66

77
## Installation
88

9-
### Development Setup
9+
### Environment setup
1010

1111
```bash
1212
git clone https://github.com/getsentry/launchpad.git
1313
cd launchpad
14+
15+
# Installs our local dependencies
1416
devenv sync
1517
```
1618

1719
If you don't have devenv installed, [follow these instructions](https://github.com/getsentry/devenv#install).
1820

1921
### Using devservices
2022

21-
[devservices](https://github.com/getsentry/devservices) provides shared Kafka infrastructure used by multiple Sentry services:
23+
[devservices](https://github.com/getsentry/devservices) manages the dependencies used by Launchpad:
2224

2325
```bash
24-
# Start shared dependencies (Kafka)
26+
# Start dependency containers (e.g. Kafka)
2527
devservices up
2628

27-
# In another terminal, start the service
29+
# Begin listening for messages
2830
launchpad serve
2931

30-
# Or run integration tests
31-
make test-service-integration
32-
33-
# Stop shared dependencies
32+
# Stop containers
3433
devservices down
3534
```
3635

3736
## Usage
3837

39-
### Testing Kafka Integration
38+
Launchpad is primarily designed to run as a Kafka consumer alongside the [Sentry monolith](https://github.com/getsentry/sentry) codebase via `launchpad serve`.
4039

41-
- `GET /health` - Basic health check
42-
- `GET /ready` - Readiness check
40+
Alternatively for a one-off analysis, such as a local size analysis, you can invoke our various CLI subcommands.
4341

44-
### Testing Kafka Integration
42+
### Size command
4543

4644
```bash
47-
# Send a test message to Kafka
48-
make test-kafka-message
49-
50-
# Send multiple test messages
51-
make test-kafka-multiple
52-
```
53-
54-
### CLI Analysis (Development)
55-
56-
```bash
57-
# Direct iOS analysis
45+
# iOS analysis
5846
launchpad size path/to/app.xcarchive.zip
5947

60-
# Analyze an APK, AAB or Zip containing a single APK or AAB
61-
launchpad size path/to/app.apk
48+
# Android analysis (AAB preferred)
6249
launchpad size path/to/app.aab
6350
launchpad size path/to/zipped_aab.zip
51+
launchpad size path/to/app.apk
6452

6553
# Skip time-consuming analysis for faster results
6654
launchpad size path/to/app.xcarchive.zip --skip-swift-metadata --skip-symbols
@@ -70,7 +58,7 @@ launchpad size path/to/app.xcarchive.zip -o my-report.json
7058
launchpad size app.apk -o detailed-report.json
7159
```
7260

73-
### Usage
61+
See `launchpad size --help` for all options:
7462

7563
```
7664
$ launchpad size --help
@@ -98,12 +86,32 @@ Options:
9886

9987
### Service Development
10088

89+
For full end-to-end development alongside the Sentry monolith, first run `sentry` in one terminal:
90+
10191
```bash
102-
# Development with shared infrastructure
103-
devservices up # Start Kafka via devservices
92+
devenv sync
93+
devservices up --mode ingest
94+
devservices serve --workers
95+
```
96+
97+
Next run `launchpad` in another terminal:
98+
99+
```bash
100+
devservices up
104101
launchpad serve
105102
```
106103

104+
And finally use the `sentry-cli` to upload to your local machine:
105+
106+
```bash
107+
sentry-cli --log-level DEBUG \
108+
--url http://dev.getsentry.net:8000/ \
109+
--auth-token $SENTRY_TOKEN \
110+
build upload YourBuild.xcarchive \
111+
--org sentry \
112+
--project internal
113+
```
114+
107115
### Testing
108116

109117
```bash

0 commit comments

Comments
 (0)