Skip to content

Latest commit

 

History

History
73 lines (39 loc) · 1.66 KB

Learn.md

File metadata and controls

73 lines (39 loc) · 1.66 KB
Raw

Learn StationGuide

Welcome to StationGuide! This guide will walk you through finding or creating issues, cloning the repo, and running the frontend and backend.

🚀 Getting Started

1. Finding or Creating Issues

  • Finding Issues: Navigate to the "Issues" tab on the repository. You’ll find a list of open issues tagged by categories like bugs, features, or enhancements.

    • Use filters like good first issue for beginner-friendly tasks.

  • Creating Issues: To create an issue:

    1. Go to the "Issues" tab.
    2. Click the "New Issue" button.
    3. Describe the problem or feature clearly and add appropriate labels (bug, feature request, etc.).

1. Clone the Repository

Understanding Cloning:

Cloning creates a local copy of the project on your computer, allowing you to work on it independently. This local copy is a mirror image of the original repository on GitHub or similar platforms.

Use Git to clone this repository into your local development environment:

bash git clone https://github.com/dhairyagothi/StationGuide.git

After Cloning You will see this interface in your system :

image

3. Running the Development Server

Frontend:

  • Open a terminal or command prompt window.
  • Navigate to the frontend directory:

Start the backend development server (typically using nodemon server.js or a similar command): Bash npm run start

Check status:

bash

git status

Create a new branch: bash

git checkout -b my-branch

Commit changes: bash git commit -m "Describe your changes"

Push to remote branch: bash git push origin my-branch

Happy Contributing !!!!