Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (27 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.03 KB

Guide to Contributing

Thank you for your interest in contributing to our project! This guide will help you get started and outline the process for contributing code and other materials.

Table of Contents

  1. Workflow

Workflow

This project uses Feature Branch Version Control Workflow.

Prerequisites

Setting up the local development environment

We use Docker to ensure a consistent development environment. Follow these steps to set up your local environment:

  1. Clone the repository:

    git clone https://github.com/agiledev-students-fall2024 4-final-project-avocado-the-study-space-tracker.git
cd 4-final-project-avocado-the-study-space-tracker

  2. Make the development script executable:

    chmod +x dev.sh

  3. Start the development environment:

    ./dev.sh

  4. Go to http://localhost:5173