Skip to content

bchainhub/foxar-docs

Repository files navigation

Foxar Documentation

Welcome to the Foxar Documentation! This repository hosts the documentation for Foxar. The documentation is built using Docusaurus system.

About Foxar

Foxar is a blazing fast, portable and modular toolkit for Core BC app development.

Getting Started with the Documentation

This project uses Docusaurus for documentation. To get started with the development or contribution to the documentation, follow the steps below.

Prerequisites

Ensure you have the following installed:

  • Node.js (v18.0 or higher)
  • npm/Yarn

Installation

  1. Clone the repository:

    git clone https://github.com/<your-username>/corepass-docs.git
  2. Navigate to the project directory:

    cd corepass-docs
  3. Install the dependencies:

    npm install

Local Development

To start a local development server and open up a browser window, run:

npm start

Build

To create a static build of the documentation, run:

npm run build

Deployment

To deploy the documentation to a static web hosting service, run:

npm run deploy

Contributing

We welcome contributions to the CorePass Developer Hub! Whether it's improving the documentation, fixing bugs, or adding new features, your contributions are greatly appreciated.

License

This project is licensed under the CORE license.

Support

For support, please open an issue in the GitHub issue tracker.