1. PROJECT OVERVIEW
Atkit is an Android application built using Kotlin, Jetpack Compose, MVVM architecture, and CameraX.
The project focuses on clean architecture, modern Android development practices, and high code quality.
2. PREREQUISITES
Before contributing, make sure you have:
- Android Studio (Latest Stable Version recommended)
- JDK 17 or above
- Git installed
- Basic knowledge of Kotlin and Jetpack Compose
- Familiarity with MVVM architecture
3. SETTING UP THE PROJECT LOCALLY
Step 1: Fork the Repository
- Click the 'Fork' button on the repository page.
Step 2: Clone Your Fork
Open a terminal and run:
git clone https://github.com/Roniscend/Atkit.git
Step 3: Navigate into the Project
cd Atkit
Step 4: Open in Android Studio
- Open Android Studio
- Click on "Open"
- Select the cloned Atkit folder
Step 5: Sync the Project
- Let Gradle sync complete
- If prompted, update Gradle or plugins
Step 6: Run the App
- Connect an Android device or start an emulator
- Click the Run button
4. BRANCHING STRATEGY
- main → stable production-ready code
- feature/ → new features
- fix/ → bug fixes
- docs/ → documentation updates
Always create a new branch before making changes:
git checkout -b feature/your-feature-name