Welcome to the Development Environment Setup guide. Here, you'll learn how to configure your local environment, install necessary dependencies, and access essential documentation—all available in Huly's Project Space.

Prerequisites

Before you begin, make sure you have the following tools installed:

• Git
• Node.js (LTS)
• Docker
• Visual Studio Code (or your preferred code editor)

Getting Started

1. Clone the Repository

git clone https://github.com/turuq-org/your-assigned-repo.git
cd your-repo

2. Install Dependencies

Using the project's package manager:

bun install

or

npm install

3. Configure Environment Variables

Copy the sample environment file available in the project's documentation within Huly and update it with your configurations, if needed:

For detailed descriptions of each variable and other setup instructions, refer to our project documentation.

Accessing Project Documentation

All essential project documentation—including requirement specifications, environment variable files, and architecture diagrams—is available in Huly's Project Space.
Explore the full documentation here:
Huly's Project Space

Next Steps

1. Follow the setup instructions above to configure your local environment.
2. Dive into Huly's Project Space for detailed project documentation.
3. Review the project overviews to understand our tech stacks and what problems our projects solve
4. Follow our development guidelines.

Welcome to Turuq—let's build something amazing together! 🎉