diff --git a/README.md b/README.md index 8d43d74..c20fec0 100644 --- a/README.md +++ b/README.md @@ -46,4 +46,5 @@ ## Third-Party Libraries and Licenses - [eslint/eslint](https://github.com/eslint/eslint) β€” [MIT](https://github.com/eslint/eslint/blob/main/LICENSE) -- [prettier/prettier](https://github.com/prettier/prettier) β€” [MIT](https://github.com/prettier/prettier/blob/main/LICENSE) \ No newline at end of file +- [prettier/prettier](https://github.com/prettier/prettier) β€” [MIT](https://github.com/prettier/prettier/blob/main/LICENSE) +- [withastro/starlight](https://github.com/withastro/starlight) - [MIT](https://github.com/withastro/starlight/blob/main/LICENSE) \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index f9f6d31..0000000 --- a/docs/README.md +++ /dev/null @@ -1,54 +0,0 @@ -# Starlight Starter Kit: Basics - -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) - -``` -npm create astro@latest -- --template starlight -``` - -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics) -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs) - -> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun! - -## πŸš€ Project Structure - -Inside of your Astro + Starlight project, you'll see the following folders and files: - -``` -. -β”œβ”€β”€ public/ -β”œβ”€β”€ src/ -β”‚ β”œβ”€β”€ assets/ -β”‚ β”œβ”€β”€ content/ -β”‚ β”‚ β”œβ”€β”€ docs/ -β”‚ └── content.config.ts -β”œβ”€β”€ astro.config.mjs -β”œβ”€β”€ package.json -└── tsconfig.json -``` - -Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name. - -Images can be added to `src/assets/` and embedded in Markdown with a relative link. - -Static assets, like favicons, can be placed in the `public/` directory. - -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | - -## πŸ‘€ Want to learn more? - -Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index b7c3e19..e310848 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -33,6 +33,31 @@ export default defineConfig({ label: 'Get currency rate - /api/getRate', slug: 'docs/endpoints/getrate' }, + { + label: 'Create charts - /api/getChart', + slug: 'docs/endpoints/create-chart' + }, + { + label: 'Get metadata - /api/metadata', + slug: 'docs/endpoints/metadata' + } + ], + }, + { + label: 'Config', + items: [ + { + label: 'Configure .env', + slug: 'docs/config/config-env' + }, + { + label: 'Configure config.yaml', + slug: 'docs/config/config-yaml' + }, + { + label: 'Configure Nginx', + slug: 'docs/config/config-nginx' + } ], }, ], diff --git a/docs/src/content/docs/docs/config/config-env.mdx b/docs/src/content/docs/docs/config/config-env.mdx new file mode 100644 index 0000000..e3553d4 --- /dev/null +++ b/docs/src/content/docs/docs/config/config-env.mdx @@ -0,0 +1,31 @@ +--- +title: Configure .env +--- + +import { Aside, Code } from '@astrojs/starlight/components'; + +Kekkai can be configured using the `.env` file in the working directory. `.env.example`. + +`.env` config is used to configure PosgreSQL running in Docker Compose. + + + + + +This config only edits the password for PosgreSQL. + +Please use only the characters `A-Za-z0-9`, without special characters or spaces \ No newline at end of file diff --git a/docs/src/content/docs/docs/config/config-nginx.mdx b/docs/src/content/docs/docs/config/config-nginx.mdx new file mode 100644 index 0000000..5debd92 --- /dev/null +++ b/docs/src/content/docs/docs/config/config-nginx.mdx @@ -0,0 +1,32 @@ +--- +title: Nginx configuration +--- + +import { Code } from '@astrojs/starlight/components'; + +Kekkai is used by `Nginx` to redirect to the correct microservice. + +## Change domain + +Change localhost to your `domain` or `ipv4` based on your needs. +If you need to use Kekkai locally, you don't need to change anything, + + + + +## Change name for SSL +This is where the name of the SSL files changes. This needs to be edited if you have a different one + +Change `privkey.pem` and `fullchain.pem` to the names of the files you have. + + diff --git a/docs/src/content/docs/docs/config/config-yaml.mdx b/docs/src/content/docs/docs/config/config-yaml.mdx new file mode 100644 index 0000000..dcd0885 --- /dev/null +++ b/docs/src/content/docs/docs/config/config-yaml.mdx @@ -0,0 +1,148 @@ +--- +title: Configure config.yaml +--- + +import { Aside } from '@astrojs/starlight/components'; + +Kekkai can be configured using the `config.yaml` file in the working directory. +`config.example.yaml`. + +```yaml +# For more information, see the documentation +# https://kekkai-docs.redume.su/ + +database: + user: 'DATABASE_USERNAME' + password: 'DATABASE_PASSWORD' + host: 'DATABASE_HOST' + name: 'DATABASE_NAME' + port: 5432 +server: + host: '0.0.0.0' + ssl: + private_key: '/CertSSL/privkey.pem' + cert: '/CertSSL/fullchain.pem' + work: true + log: + print: true + level: 'info' +analytics: + plausible_api: 'https://plausible.io/api/event/' + plausible_domain: 'PLAUSIBLE_DOMAIN' + plausible_token: 'PLAUSIBLE_TOKEN' + work: false +currency: + chart: + save: false + collecting: + fiat: true + schedule: '30 8 * * *' + fiat: + - USD + - RUB + - EUR + - UAH + - TRY + - KZT +``` + +## Database +Kekkai is used as a `PostgreSQL` database. + + + +## Server + + +### SSL +Create a folder CertSSL to store your certificates +```shell +mkdir CertSSL +``` + +Copy your certificates to the CertSSL folder. + +It is recommended to rename the certificates to `privkey.pem` and `fullchain.pem`. +If this is not possible, +you need to change the SSL name in `nginx.conf` (if using Docker Compose) + +## Analytics +Kekkai uses [`Plausbile`](https://plausible.io/) as an analyst. +Minimal data is transferred for anilithics. +Such as: browser, OS, status code, url, where the user came from. +Most of the data is built on User Agent. +It is possible to disable analytics in Kekkai. + +```yaml +... +analytics: + plausible_api: 'https://plausible.io/api/event/' + plausible_domain: 'PLAUSIBLE_DOMAIN' + plausible_token: 'PLAUSIBLE_TOKEN' + work: true +... +``` + +- `plausible_api`: This is where the Plausible instance is specified. + The official instance is specified by default. +- `plausible_domain`: Kekkai Instance Domain. + It should be added to Plausible first, and then to the config. + You can add the domain [here](https://plausible.io/sites/new?flow=provisioning). +- `plausible_token`: Api token for authorization and sending requests. +You can create it [here](https://plausible.io/settings/api-keys). +- `work`: Enable or disable analytics. + +## Currency +`DuckDuckGo` (fiat currency collection) and `CoinMarketCap` (cryptocurrency collection) +are used to collect currency rates. + + +```yaml +... +currency: + chart: + save: false # Enable or disable saving graphs to an image (Boolean) + collecting: + fiat: true # Turn off or turn on the collection of the fiat currency rate [Boolean] + crypto: false + schedule: '30 8 * * *' # Currency collection schedule in crontab format [String] + crypto_apikey: 'APIKEY' + fiat: # List of fiat currency to save the exchange rate [Array] + - USD + - RUB + - EUR + - UAH + - TRY + - KZT + crypto: + - ETH + - TON + - USDT +``` + +- `currency.chart.save`: Enable or disable saving graphs. +- `currency.collecting`: Enable or disable cryptocurrency +or fiat currency exchange rate collection. +- `currency.schedule`: Currency collection interval (Configurable via cron. + It is recommended to use [crontab.guru](https://crontab.guru), + not supported in `Non-standard format`, like `@daily`). +- `crypto.crypto_apiKey`: API-key from CoinMarketCap service +- `currency.fiat`: A list of fiat currencies that will be saved to the database. +- `currency.crypto`: A list of crypto currencies that will be saved to the database. \ No newline at end of file diff --git a/docs/src/content/docs/docs/endpoints/create-chart.mdx b/docs/src/content/docs/docs/endpoints/create-chart.mdx new file mode 100644 index 0000000..a14063f --- /dev/null +++ b/docs/src/content/docs/docs/endpoints/create-chart.mdx @@ -0,0 +1,172 @@ +--- +title: Create Charts - /api/getChart +--- + +Creating a currency rate chart. + +import { Tabs, TabItem, Aside } from '@astrojs/starlight/components'; + + +## Creating a graph for a certain period +### Request + + + + + +```shell +curl --request GET --url https://kekkai-api.redume.su/api/getChart/week?from_currency=RUB&conv_currency=USD +``` + + + + + + +```python +import requests + +res = requests.get('https://kekkai-api.redume.su/api/getChart/week', { + 'from_currency': 'USD', + 'conv_currency': 'RUB', +}, timeout=3) + +print(res.json()) +``` + + + + + + +```javascript +const axios = require('axios'); + +axios.get('https://kekkai-api.redume.su/api/getChart/week', { + timeout: 3000, + 'from_currency': 'USD', + 'conv_currency': 'RUB', +}) + .then((res) => { + console.log(res['data']); + }) + .catch((err) => { + console.error(err); + }); +``` + + + + + + + +### Query params +| Parameter | Description | +|-------------------|-------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | + +### URL params +| Parameter | Description | +|---------------|-------------------------------------------------------------------------| +| `period` | Available parameters: `week`, `month`, `quarter`, `year` | + +`*` - Required arguments + +### Response + + + +## Creating a schedule for specific days +### Request + + + + + +```shell +curl --request GET --url https://kekkai-api.redume.su/api/getChart/?from_currency=RUB&conv_currency=USD&start_date=2024-10-31&end_date=2024-11-08 +``` + + + + + + +```python +import requests + +res = requests.get('https://kekkai-api.redume.su/api/getChart/', { + 'from_currency': 'USD', + 'conv_currency': 'RUB', + 'start_date': '2024-10-31', + 'end_date': '2024-11-08' +}, timeout=3) + +print(res.json()) +``` + + + + + + +```javascript +const axios = require('axios'); + +axios.get('https://kekkai-api.redume.su/api/getChart/', { + timeout: 3000, + 'from_currency': 'USD', + 'conv_currency': 'RUB', + 'start_date': '2024-10-31', + 'end_date': '2024-11-08' +}) + .then((res) => { + console.log(res['data']); + }) + .catch((err) => { + console.error(err); + }); +``` + + + + + +### Query params +| Parameter | Description | +|------------------|------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | +| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` | +| `end_date`* | Period end date in the format `YYYYY-DD-MM` | + +`*` - Required arguments + +### Response + + + +## What the name of the chart file consists of +Example: ``.../RUB_USD_20241108_DQVDN7.png`` + +- `RUB_USD` - Name of currencies. +- `20241108` - Schedule request date in `YYYMMDD` format. +- `DQVDN7` - Random file character identifier. + +All charts are in the charts folder, which is in the root directory (`/chart`) \ No newline at end of file diff --git a/docs/src/content/docs/docs/endpoints/metadata.mdx b/docs/src/content/docs/docs/endpoints/metadata.mdx new file mode 100644 index 0000000..79cebbe --- /dev/null +++ b/docs/src/content/docs/docs/endpoints/metadata.mdx @@ -0,0 +1,79 @@ +--- +title: Get metadata - /api/metadata +--- + +Currencies are identified by standard three-letter `ISO 4217` currency codes. + +import { Tabs, TabItem, Aside } from '@astrojs/starlight/components'; + +## Get data on available dates and currencies. +### Request + + + + + +```shell +curl --request GET --url https://kekkai-api.redume.su/api/metadata/ +``` + + + + + + +```python +import requests + +res = requests.get('https://kekkai-api.redume.su/api/metadata/', timeout=3) + +print(res.json()) +``` + + + + + + +```javascript +const axios = require('axios'); + +axios.get('https://kekkai-api.redume.su/api/metadata/') + .then((res) => { + console.log(JSON.stringify(res.json())); + }) + .catch((err) => { + console.error(err); + }); +``` + + + + + +### Response + + \ No newline at end of file