Get Started

This guide will help you quickly set up your development environment and make your first contribution to Databayt. Whether you're a seasoned developer or just starting out, we'll walk you through everything you need to know.

Prerequisites

Before you begin, make sure you have the following set up:

Quick Start

Get up and running in 5 minutes:

1. Fork & Clone

First, fork the repository you want to contribute to on GitHub, then clone it locally:

# Replace [repository] with the specific repo you want to contribute to
git clone https://github.com/your-username/[repository].git
cd [repository]

2. Install Dependencies

Install all project dependencies using pnpm:

pnpm install

3. Set Up Environment

Copy the environment variables file and configure as needed:

cp .env.example .env.local

4. Start Development Server

Run the development server:

pnpm dev

Your app should now be running at http://localhost:3000 🎉

Your First Contribution

Finding Something to Work On

Making Changes

1. Create a branch for your changes:

   git checkout -b feature/your-feature-name
   

2. Make your changes following our coding patterns

3. Test your changes locally:

   pnpm build
   pnpm lint
   

4. Commit your changes using conventional commits:

   git add .
   git commit -m "feat: add new component feature"
   

5. Push and create a Pull Request:

   git push origin feature/your-feature-name
   

Development Workflow

Project Structure

Understanding our architecture helps you navigate the codebase:

src/
├── app/                 # Next.js app router
├── components/          # Reusable UI components
│   ├── ui/             # Basic UI primitives
│   ├── landing/        # Landing page components
│   └── [feature]/      # Feature-specific components
├── lib/                # Utility functions
├── styles/             # Global styles
└── types/              # TypeScript type definitions

Key Commands

Getting Help

Community Support

Mentorship Program

New contributors get paired with experienced mentors who provide:

• Code review and feedback
• Guidance on best practices
• Help with technical challenges
• Career development advice

Next Steps

Once you're set up and have made your first contribution:

1. Explore the codebase - Browse different repositories to understand our ecosystem
2. Read the patterns - Check our development patterns guide
3. Join the community - Connect with other contributors on Discord
4. Find your niche - Identify areas that match your interests and skills
5. Share your work - Showcase your contributions and get feedback

Resources

Essential Reading

• Architecture Overview – Understand our system design
• Development Patterns – Learn our coding standards
• Contributing Guide – Detailed contribution guidelines
• Revenue Sharing – How contributors earn from their work

Quick Links

• GitHub Organization
• Discord Community
• Issue Tracker
• Project Roadmap

---

Ready to build something amazing? The best way to learn is by doing. Pick a good first issue and start contributing today. Remember, every expert was once a beginner, and we're here to support your journey every step of the way.