Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bchainhub/foxar-docs
Foxar documentation portal
https://github.com/bchainhub/foxar-docs
core core-blockchain docs foxar
Last synced: about 10 hours ago
JSON representation
Foxar documentation portal
- Host: GitHub
- URL: https://github.com/bchainhub/foxar-docs
- Owner: bchainhub
- License: other
- Created: 2024-04-24T14:03:14.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-18T19:53:51.000Z (6 months ago)
- Last Synced: 2024-05-19T14:01:44.559Z (6 months ago)
- Topics: core, core-blockchain, docs, foxar
- Language: TypeScript
- Homepage:
- Size: 7.24 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```sh
git clone https://github.com//corepass-docs.git
```
2. Navigate to the project directory:
```sh
cd corepass-docs
```
3. Install the dependencies:
```sh
npm install
```
### Local Development
To start a local development server and open up a browser window, run:
```sh
npm start
```
### Build
To create a static build of the documentation, run:
```sh
npm run build
```
### Deployment
To deploy the documentation to a static web hosting service, run:
```sh
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.