https://github.com/redhatinsights/quickstarts
Backend service for integrated quickstarts.
https://github.com/redhatinsights/quickstarts
Last synced: 23 days ago
JSON representation
Backend service for integrated quickstarts.
- Host: GitHub
- URL: https://github.com/redhatinsights/quickstarts
- Owner: RedHatInsights
- License: mit
- Created: 2021-09-14T11:43:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T02:26:44.000Z (23 days ago)
- Last Synced: 2025-05-08T03:51:26.262Z (23 days ago)
- Language: Go
- Homepage:
- Size: 12.3 MB
- Stars: 6
- Watchers: 15
- Forks: 59
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Quickstarts
Backend service for integrated quickstarts.
## [Help Topics contribution guide](https://github.com/RedHatInsights/quickstarts/blob/main/docs/help-topics/README.md)
## [Quickstarts (Learning resources) contribution guide](https://github.com/RedHatInsights/quickstarts/blob/main/docs/quickstarts/README.md)
## [Quickstarts Common Issues](https://github.com/RedHatInsights/frontend-components/blob/master/packages/docs/pages/quickstarts/common-issues.mdx)
## Run the service locally
1. There are environment variables required for the application to start. It's
recommended you copy `.env.example` to `.env` and set these appropriately for local development.
2. Migrate the database: `make migrate`. It will seed the BD with testing quickstart
3. Start the server: `go run main.go`
4. Query data:
```sh
curl --location --request GET 'http://localhost:8000/api/quickstarts/v1/quickstarts/'
curl --location --request GET 'http://localhost:8000/api/quickstarts/v1/quickstarts/?bundle[]=rhel&bundle[]=insights'
```
### IMPORTANT
`oc port-forward -n quickstarts svc/quickstarts-service 8000:8000`!
## Sample requests
### Create progress
```sh
curl --location --request POST 'http://localhost:8000/api/quickstarts/v1/progress' --header 'Content-Type: application/json' --data-raw '{
"accountId": 123, "quickstartName": "some-name", "progress": {"Some": "Progress-updated"}
}'
```
### Delete progress
```sh
curl --location --request DELETE 'http://localhost:8000/api/quickstarts/v1/progress/14'
```