Skip to content

Commit

Permalink
Updated instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
robmoffat committed Jul 23, 2024
1 parent 0678fe4 commit 2a595d8
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,35 @@ Project Analysis is a tool that scan the FINOS (Fintech Open Source Foundation)

**Clone the repository**:

```sh
git clone https://github.com/finos-labs/project-analysis.git
cd project-analysis
```
```sh
git clone https://github.com/finos-labs/project-analysis.git
cd project-analysis
```

To scan the FINOS project landscape and gather data, run:
```sh
LANDSCAPE_SCANNING_TOKEN={your-github-personal-access-token} mvn spring-boot:run -Dspring-boot.run.profiles=local,summarize -DskipTests
```

```sh
LANDSCAPE_SCANNING_TOKEN={your-github-personal-access-token}
mvn spring-boot:run
```

To build the Jupyter notebook:

```sh
python3 -m venv env
./env/bin/python -m pip install -r requirements.txt
```

Open `project-report.ipynb` in VS Code and run the notebook; make sure that the `Jupyter` VS Code Extension is installed.

#### Generating a Pull Request

To create a [pull request to Project Analysis](https://github.com/finos-labs/project-analysis/pulls) at the end of the run, set this before running:

```sh
SPRING_PROFILES_ACTIVE=pr
```

#### Generating a Personal Access Token

To generate a personal access token, follow the instructions [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
Expand Down

0 comments on commit 2a595d8

Please sign in to comment.