Skip to content

Commit

Permalink
Merge pull request #29 from MrityunjaySingh09/main
Browse files Browse the repository at this point in the history
Create Learn.md
  • Loading branch information
dhairyagothi authored Oct 1, 2024
2 parents b369233 + 895e6cd commit 34f1aff
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions Learn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# 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](https://github.com/user-attachments/assets/20961ae0-2d63-45e7-9aa4-9adc01fcc4d0)



### 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 !!!!

0 comments on commit 34f1aff

Please sign in to comment.