Getting Started

🚀 Getting Started with eOzka

Welcome to the eOzka Organization! Whether you are a seasoned software engineer looking to contribute to our core libraries, or a student looking for your very first open-source PR, we are thrilled to have you here.

This guide will demystify our ecosystem and help you get your local development environment set up efficiently.

🛠️ The eOzka Tech Stack

Because we build a wide variety of tools (from web extensions to health-tech mobile apps), our repositories span several languages. Before diving into a project, ensure you have the relevant tools installed on your machine:

1. For Web & Core Projects:
   • Git (Required for all projects)
   • Node.js (LTS) & npm
2. For Mobile Projects (e.g., Stress Calculator):
   • Flutter SDK
   • Android Studio / Xcode (depending on your target OS)

🗺️ Finding Your First Project

Taking the first step in a new organization can be daunting. Here is the easiest path forward:

1. Navigate to our 🗂️ Our Projects directory. Browse the list and find a project whose Tech Stack aligns with your skills.
2. Click through to the project's dedicated Wiki page or its GitHub Repository.
3. Look for the README.md file in the root directory. Every eOzka project is required to maintain its own unique, specialized setup instructions.
4. Check the repository's Issues tab and filter by the good first issue or help wanted labels.

💻 General Setup Workflow

While every project is unique, the standard workflow across our organization is:

# 1. Clone the repository locally
git clone https://github.com/eOzkull/[Repo-Name].git

# 2. Enter the directory
cd [Repo-Name]

# 3. Read the specific setup script (often a package.json or pubspec.yaml)
# ... install dependencies ...

👋 Next Steps

Once you have a project running locally:

• Review our Contributing guidelines to learn how we manage Pull Requests.
• Jump into the Communication page to introduce yourself to the team!
• If things aren't compiling or you run into weird bugs, check out the Support page!