https://github.com/codatio/codat-docs

Build powerful applications with financial data
https://github.com/codatio/codat-docs

api codat documentation docusaurus

Last synced: 10 days ago
JSON representation

Build powerful applications with financial data

• Host: GitHub
• URL: https://github.com/codatio/codat-docs
• Owner: codatio
• License: apache-2.0
• Created: 2023-02-04T23:50:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-05T13:04:44.000Z (10 days ago)
• Last Synced: 2024-11-05T14:19:20.008Z (10 days ago)
• Topics: api, codat, documentation, docusaurus
• Language: SCSS
• Homepage: https://docs.codat.io/
• Size: 130 MB
• Stars: 18
• Watchers: 8
• Forks: 37
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Support: docs/support/get-help.mdx

Awesome Lists containing this project

README

        
# Codat docs

The official [Codat](https://codat.io) documentation.

- [Browse the docs](https://docs.codat.io/)

- [Contributing Guide](./CONTRIBUTING.md)

- [OpenAPI Spec](https://github.com/codatio/oas)

![Website Deploy](https://deploy-badge.vercel.app/?url=https://vercel.com/codat/codat-docs&name=website) [![Linkinator CI](https://github.com/codatio/codat-docs/actions/workflows/linknator.yml/badge.svg)](https://github.com/codatio/codat-docs/actions/workflows/linknator.yml)

---

## Running locally

### Prerequisites

#### Git LFS

This website uses [Git Large File Storage] (LFS) to efficiently store images. You need to install Git LFS.

```

brew install git-lfs

git lfs install

```

All `.jpg`, `.jpeg`, and `.png` files are tracked.

[Read more](https://git-lfs.com/)

#### Create a .env file

The docusaurus config expects certain environment variables to be defined. We've included `.env.example` - copy this and rename it to `.env`. You can enter any random string for the IDs.

```

copy .env.example .env # on Windows 

cp .env.example .env # on Mac

```

### Install npm dependencies

```sh

npm install

```

### Run the project

```sh

npm run start

```

### Editing article markdown files

`/docs`

---

Updates feed: 

---

Built with [Docusaurus](https://docusaurus.io/).