info_tfgrid/docs_projectinca/README.md

Project INCA Docs

Table of Contents

• Introduction
• Prerequisites
  • Install the prerequisites on Ubuntu
  • Install the prerequisites on MAC or Linux with Brew
  • Check if the Prerequisites Are Installed
• Clone the Repository
• Preview the Website
• License
• References
• Contribute

---

Introduction

This subrepository contains the code to deploy the Project INCA Docs website, a project by ThreeFold.

Prerequisites

You need npm to run this website.

To clone the repository, you need git.

To use the Makefile for quick deployment, you need make

Install the prerequisites on Ubuntu

sudo apt update
sudo apt install nodejs
sudo apt install git
sudo apt install make

Install the prerequisites on MAC or Linux with Brew

• Install Brew

  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  

• Install the prerequisites

  brew install node
  brew install git
  brew install make
  

Check if the Prerequisites Are Installed

npm --version
git version
make --version

Clone the Repository

git clone https://git.ourworld.tf/tfgrid/info_tfgrid
cd info_tfgrid/docs_projectinca

For more information, read the original AstroWind docs.

Preview the Website

You can preview the website with those two lines.

npm install
npm run dev

The equivalent can be achieved using the Makefile:

make run

License

INCA Docs is licensed under the Apache 2.0 license — see the LICENSE file for details.

References

This Project INCA Docs website is based on the amazing AstroWind Starlight repo.

We changed the license from MIT to Apache 2.0 to suit this specific project.

Contribute

To contribute to this repository:

• Make a new branch with development_ as a prefix (e.g. development_update)
• Make changes locally on your code editor
• Push changes to the new branch
• Make a pull request to development branch

The code owners will merge development branch to main branch.