Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 2.45 KB

setup.md

File metadata and controls

94 lines (71 loc) · 2.45 KB

Development Environment Setup

This document outlines the standard development environment setup for all Bayat projects.

IDEs and Text Editors

Recommended IDEs

  • Visual Studio Code - For web, JavaScript, TypeScript, and Python development
  • Visual Studio - For C# and .NET development
  • JetBrains IDEs - Project-specific IDEs (PyCharm, WebStorm, Rider, etc.)
  • Xcode - For iOS and macOS development
  • Android Studio - For Android development

Editor Configuration

  • Use the standard .editorconfig file provided in the project template
  • Configure auto-formatting on save
  • Use consistent tab/space settings (2 spaces for web languages, 4 spaces for others)

Extensions and Plugins

Required Extensions for VS Code

  • ESLint
  • Prettier
  • GitLens
  • Docker
  • Project-specific language extensions

Required Plugins for JetBrains IDEs

  • SonarLint
  • Git Integration
  • Project-specific language plugins

Linting and Formatting

JavaScript/TypeScript

  • ESLint with our standard ruleset
  • Prettier for formatting

Python

  • Flake8 for linting
  • Black for formatting

C#

  • StyleCop for analysis
  • EditorConfig for formatting

Local Environment Setup

Development Dependencies

  • Node.js - Latest LTS version
  • Python - Version 3.9+
  • Docker - Latest stable version
  • Git - Latest stable version
  • Project-specific runtime environments

Environment Variables

  • Use .env files for local development
  • Never commit sensitive values to the repository
  • Document required environment variables in the project README

Version Control Integration

  • Configure Git with appropriate user name and email
  • Set up SSH keys for repository access
  • Use the standard .gitignore file provided in the project template

Containerization

  • Use Docker for local development when applicable
  • Follow the standard Docker configuration provided in project templates

Troubleshooting

Common issues and their solutions:

  • Package manager conflicts
  • Environment variable misconfigurations
  • IDE-specific issues

New Team Member Setup

Step-by-step guide for new team members to set up their development environment, including:

  1. Installing required software
  2. Configuring IDE and extensions
  3. Setting up version control
  4. Running project-specific setup scripts