Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: rename blink products and remove from galoy docs #27

Merged
merged 4 commits into from
May 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/contribute/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Join our self-hosted Mattermost server at [chat.galoy.io](https://chat.galoy.io)

Earn sats by contributing to the Galoy stack:

[github.com/GaloyMoney/galoy/discussions/categories/bounties](https://github.com/GaloyMoney/galoy/discussions/categories/bounties)
[github.com/GaloyMoney/blink/discussions/categories/bounties](https://github.com/GaloyMoney/blink/discussions/categories/bounties)

## Community apps and projects

Expand Down
2 changes: 0 additions & 2 deletions docs/deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## Setting up the Galoy stack locally

* [Backend Servers](/deployment/backend-servers)
* [Mobile Wallet](/deployment/mobile-wallet)
* [Galoy Pay](/deployment/galoy-pay)
* [Admin Panel](/deployment/admin-panel)

## Videos
Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/b-backend-servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /deployment/backend-servers

## Run locally

Find how to run the backend servers locally in the [project readme](https://github.com/GaloyMoney/galoy#local-development-setup)
Find how to run the backend servers locally in the [project readme](https://github.com/GaloyMoney/blink#local-development-setup)

## How to expose the API including websocket subscriptions

Expand All @@ -27,7 +27,7 @@ For a fork, you can still use that same apollo studio link and configure the reg

## How to run integration tests with Galoy as a dependency

Take a look at the [Quickstart](https://github.com/GaloyMoney/galoy/tree/main/quickstart) if you want to take it for a spin.
Take a look at the [Quickstart](https://github.com/GaloyMoney/blink/tree/main/quickstart) if you want to take it for a spin.

## Known issues

Expand Down
49 changes: 0 additions & 49 deletions docs/deployment/c-galoy-pay.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/deployment/d-mobile-wallet.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/deployment/f-admin-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Galoy Admin Panel lets the support team access users and internal transaction in

Admin Panel is packaged as a docker image, and is automatically installed as part of the galoy helm charts.

With a default installation, Admin Panel can be accessed with `admin.domain.com`. Admin-Panel fetches information from a dedicated graphql API endpoint `graphql-admin.domain.com` defined in [graphql-admin-server](https://github.com/GaloyMoney/galoy/blob/main/src/servers/graphql-admin-server.ts)
With a default installation, Admin Panel can be accessed with `admin.domain.com`. Admin-Panel fetches information from a dedicated graphql API endpoint `graphql-admin.domain.com` defined in [graphql-admin-server](https://github.com/GaloyMoney/blink/blob/main/src/servers/graphql-admin-server.ts)

### How to run this repo locally?

Expand Down
3 changes: 1 addition & 2 deletions docs/products/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

Find more info here about the main components of the Galoy stack.

* **[Galoy Core](/products/galoy-core)** and **[API](/products/api)** – interacts with the bitcoin and accounting layers to enable sending, receiving and holding balances
* **[Blink Core](/products/blink-core)** – interacts with the bitcoin and accounting layers to enable sending, receiving and holding balances and serves the API
* **[Stablesats](/products/stablesats)** – service for implementing fiat hedging strategies via supported exchanges; enables the provision of synthetic USD to provide dollar-like stability without stablecoins
* **[Bria](/products/bria)** - a service for transaction batching and onchain liquidity management
* **[Galoy CLI](/products/galoy-cli)** - a Command Line Interface (CLI) client for interacting with Galoy Core
46 changes: 46 additions & 0 deletions docs/products/a-blink-core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
id: blink-core
title: Galoy Core
slug: /products/blink-core
---

import GitHubButton from 'react-github-btn'

# Galoy Core

<GitHubButton href="https://github.com/GaloyMoney/blink" data-color-scheme="no-preference: dark; light: light; dark: dark;" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star GaloyMoney/blink on GitHub">Star</GitHubButton>
<div style={{ marginBottom: 20 }}></div>

Galoy Core is an opinionated bitcoin banking platform.

This repo represents the main API that brings all functionality together. Take a look at the [Quickstart](https://github.com/GaloyMoney/blink/tree/main/quickstart) if you want to take it for a spin.

## Project readme

https://github.com/GaloyMoney/blink#readme

## Project website

https://blink.sv/

## Hosted API
To try the hosted instance of our API visit the [Blink Developer Documentation](https://dev.blink.sv/api)<br />
There you can find:
* an interactive tutorials to get started with the API
* the endpoints to use for mainnet and signet bitcoin
* a Postman collection and environment variables
* generated GraphQL queries in multiple programming languages
* API reference documentation

## Local `dev` API access
For the local `dev` environment
* clone the galoy repo: https://github.com/GaloyMoney/blink
* follow the steps in the [readme](https://github.com/GaloyMoney/blink/tree/main?tab=readme-ov-file#local-development-setup) start hosting the API locally

Find more details about hosting the Galoy stack yourself in the [deployment section](/deployment/).

## Admin API

### [Blink admin API reference](https://dev.galoy.io/admin-api-reference.html)
### Preformed GraphQL queries
* [galoy/tree/main/core/api/test/bats/admin-gql](https://github.com/GaloyMoney/blink/tree/main/core/api/test/bats/admin-gql)
24 changes: 0 additions & 24 deletions docs/products/a-galoy-core.md

This file was deleted.

27 changes: 0 additions & 27 deletions docs/products/b-api.md

This file was deleted.

24 changes: 0 additions & 24 deletions docs/products/e-galoy-cli.md

This file was deleted.

4 changes: 0 additions & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -187,10 +187,6 @@ const config = {
to: '/contribute',
from: ['/projects'],
},
{
to: '/products/api',
from: ['/api'],
},
],
},
],
Expand Down
6 changes: 3 additions & 3 deletions scripts/generate-admin-api-reference.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ if ! npx spectaql --version; then yarn add spectaql --non-interactive; fi
mkdir -p .temp
cd .temp || exit 1

# checkout galoy
# checkout blink
if [ ! -d "galoy" ]; then
git clone https://github.com/GaloyMoney/galoy
git clone https://github.com/GaloyMoney/blink
fi
cd galoy || exit 1
cd blink || exit 1

# build admin api reference
npx spectaql ./../../scripts/spectaql/spectaql-config-admin-api.yml \
Expand Down
6 changes: 3 additions & 3 deletions scripts/generate-public-api-reference.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ if ! npx spectaql --version; then yarn add spectaql --non-interactive; fi
mkdir -p .temp
cd .temp || exit 1

# checkout galoy
# checkout blink
if [ ! -d "galoy" ]; then
git clone https://github.com/GaloyMoney/galoy
git clone https://github.com/GaloyMoney/blink
fi
cd galoy || exit 1
cd blink || exit 1

# build public api reference
npx spectaql ./../../scripts/spectaql/spectaql-config-public-api.yml \
Expand Down
2 changes: 1 addition & 1 deletion scripts/spectaql/spectaql-config-public-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ info:
url: https://opensource.org/licenses/MIT

servers:
- url: https://api.staging.galoy.io/graphql
- url: https://api.staging.blink.sv/graphql
description: Signet
production: false
17 changes: 8 additions & 9 deletions src/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,17 @@ The Galoy core banking platform includes the parts necessary to launch a communi

### Backend

* **[Galoy Core](/products/galoy-core)** – interacts with the bitcoin and accounting layers to enable sending, receiving and holding balances.
Check out the [API section ](/api) for an interactive tutorial to get started with our hosted instance.
* **[Stablesats](/products/stablesats)** – service for implementing fiat hedging strategies via supported exchanges; enables the provision of synthetic USD to provide dollar-like stability without stablecoins.
* **[Bria](/products/bria)** - a service for transaction batching and onchain liquidity management.
* **[Galoy CLI](/products/galoy-cli)** - a Command Line Interface (CLI) client for interacting with Galoy Core.
* **[Blink Core](products/blink-core)** – interacts with the bitcoin and accounting layers to enable sending, receiving and holding balances.
Check out the [dev.blink.sv/api](https://dev.blink.sv) for an interactive tutorial to get started with our hosted instance.
* **[Stablesats](products/stablesats)** – service for implementing fiat hedging strategies via supported exchanges; enables the provision of synthetic USD to provide dollar-like stability without stablecoins.
* **[Bria](products/bria)** - a service for transaction batching and onchain liquidity management.

### Apps

#### End-user and merchant experiences

* **[Mobile Wallet](https://github.com/GaloyMoney/galoy-mobile)** – simple end user experience enables send/receive onchain and Lightning. Mobile wallet includes educational onboarding quiz & merchant map.
* **[Galoy Pay](https://github.com/GaloyMoney/galoy-pay)** – web application end users can share online or display in person to receive payments to their account.
* **[Mobile Wallet](https://github.com/GaloyMoney/blink-mobile)** – simple end user experience enables send/receive onchain and Lightning. Mobile wallet includes educational onboarding quiz & merchant map.
* **[Blink Pay](https://github.com/GaloyMoney/blink-pay)** – web application end users can share online or display in person to receive payments to their account.

#### Administrator experiences

Expand All @@ -42,5 +41,5 @@ Check out the [API section ](/api) for an interactive tutorial to get started wi
## API Reference

Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API:
* [Galoy public API reference ](https://dev.galoy.io/public-api-reference.html)
* [Galoy admin API reference](https://dev.galoy.io/admin-api-reference.html)
* [Blink public API reference](https://dev.galoy.io/public-api-reference.html)
* [Blink admin API reference](https://dev.galoy.io/admin-api-reference.html)
1 change: 1 addition & 0 deletions typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# don't correct these false positives
ags = "ags"
aray = "aray"
JOD = "JOD"

[files]
# skip these files
Expand Down
Loading