Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
JulienPeloton committed Dec 6, 2024
1 parent f587ef9 commit e089e13
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ The Fink cutout API is a Flask application to access cutouts from the Fink datal

## Documentation

The user documentation can be found at this [link](https://fink-broker.readthedocs.io/en/latest/services/search/getting_started/#quick-start-api). Documentation for developpers and maintainers can be found on [GitLab](https://gitlab.in2p3.fr/fink/rubin-performance-check/-/blob/main/portal/README.md?ref_type=heads) (auth required).
There are several forms of documentation, depending on what you are looking for:

- Tutorials/How-to guides: [Fink user manual](https://fink-broker.readthedocs.io/en/latest/services/search/getting_started/#quick-start-api)
- API Reference guide: [https://api.fink-portal.org](https://api.fink-portal.org)
- Notes for developpers and maintainers (auth required): [GitLab](https://gitlab.in2p3.fr/fink/rubin-performance-check/-/blob/main/portal/README.md?ref_type=heads)

## Requirements and installation

Expand All @@ -24,15 +28,15 @@ The input parameters can be found in [config.yml](config.yml). Make sure that th

### Debug

After starting [fink-cutout-api](https://github.com/astrolabsoftware/fink-cutout-api), you can simply test the API using:
After starting the Fink Java Gateway and [fink-cutout-api](https://github.com/astrolabsoftware/fink-cutout-api) services, you can simply launch the API in debug mode using:

```bash
python app.py
```

### Production

The application is simply managed by `gunicorn` and `systemd` (see [install](install/README.md)), and you can simply manage it using:
The application is simply managed by `gunicorn` and `systemd` (see [install](install/README.md)), and you can manage it using:

```bash
# start the application
Expand Down

0 comments on commit e089e13

Please sign in to comment.