Welcome to the Gear network documentation portal for developers! This guide will help you get started with building the Gear Wiki locally, allowing you to explore and contribute to the Gear ecosystem. Whether you’re a seasoned developer or just starting out, this user-friendly guide is here to ensure a smooth setup process.
Prerequisites
Before diving into the setup, ensure you have the following software installed:
Step-by-Step Guide to Build Locally
1. Clone the Wiki Repository
First, you’ll want to clone the Gear Wiki repository to your local machine. Use the following commands:
git clone https://github.com/gear-foundation/gear-wiki.git
cd wiki
2. Install Dependencies
After cloning the repository, install the required dependencies. You can choose between Yarn or npm:
yarn install
# Alternatively
npm install
3. Start Your Local Wiki Copy
Now that everything is set up, you can start your local version of the Wiki. Open it in your default browser by running:
yarn start
# Alternatively
npm run start
Your local instance will be available at http://localhost:3000.
Running with Locale Options
If you want to view the Wiki in a specific locale, you can use the following command:
yarn start --locale
# Example for Chinese version
yarn start --locale zh-cn
Troubleshooting
If you encounter any issues during the setup or running of your local Wiki, here are some troubleshooting ideas:
- Make sure Node.js and Yarn are correctly installed by running
node -v
andyarn -v
in your terminal. - Check if you are in the correct directory by using
pwd
to view your current path. - If the application doesn’t start, try clearing the cache with
yarn cache clean
ornpm cache clean --force
. - For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
Contributing to the Gear Wiki
If you have something to share or add to the Wiki, feel free to open an issue or create a pull request!
Conclusion
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.