-
Notifications
You must be signed in to change notification settings - Fork 128
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
259 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,41 @@ | ||
# STATION GUIDE : YOUR PLATFORM GUIDE | ||
# STATION GUIDE : YOUR PLATFORM GUIDE | ||
|
||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
|
||
[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-) | ||
<!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-) | ||
|
||
|
||
[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-) | ||
|
||
|
||
<!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
|
||
<a href="[https://github.com/Dhairyagoth](https://github.com/dhairyagothi)i"><img src="https://readme-typing-svg.demolab.com?font=Fira+Code&pause=1000&color=DEF72C&random=false¢er=false &width=1000&lines=Station Saarthi %2C+Your+Platform+Guide" alt="Typing SVG" /></a> | ||
welcome to repository of Station Guide | ||
Welcome to repository of Station Guide | ||
|
||
- To get to know about Station Guide Check : - [StationGuide.md](https://github.com/dhairyagothi/StationGuide/blob/f2d4795cf3d3c57ffafb6ce007f47173d7010b1e/StationGuide.md) | ||
|
||
- To check UI Prototype Figma design :- [StationGuideFigma.md](https://github.com/dhairyagothi/StationGuide/blob/f2d4795cf3d3c57ffafb6ce007f47173d7010b1e/StationGuideFigma.md) | ||
|
||
# Using Station Guide | ||
## Table of Content | ||
|
||
- **[Using Station Guide](#using-station-guide)** | ||
- **[Getting Started](#getting-started)** | ||
- **[Project Structure](#project-structure)** | ||
- **[How to Contribute](#how-to-contribute)** | ||
- **[Code of Conduct](#code-of-conduct)** | ||
- **[How to Fork](#how-to-fork)** | ||
- **[Contributors](#contributors)** | ||
- **[Contact Information](#contact-information)** | ||
|
||
## Using Station Guide | ||
|
||
This project utilizes React for the frontend and Express for the backend, providing a robust foundation for your web application development. | ||
|
||
## Prerequisites | ||
### Prerequisites | ||
|
||
To get started, you'll need the following: | ||
|
||
|
@@ -25,15 +44,12 @@ To get started, you'll need the following: | |
|
||
## Getting Started | ||
|
||
|
||
### 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 | ||
|
@@ -45,39 +61,42 @@ You will see this interface in your system : | |
|
||
![image](https://github.com/user-attachments/assets/20961ae0-2d63-45e7-9aa4-9adc01fcc4d0) | ||
|
||
### 2. Running the Development Server | ||
|
||
|
||
### 3. Running the Development Server | ||
|
||
## Frontend: | ||
#### Frontend: | ||
|
||
- Open a terminal or command prompt window. | ||
- Navigate to the frontend directory: | ||
|
||
```Bash | ||
cd frontend | ||
``` | ||
|
||
- Start the frontend development server : | ||
|
||
```Bash | ||
npm run dev | ||
``` | ||
|
||
This will typically launch the React application on http://localhost:3000 (or the specified port) in your browser. | ||
|
||
## Backend: | ||
#### Backend: | ||
|
||
- Open another terminal or command prompt window (separate from the frontend window). | ||
- Navigate to the backend directory: | ||
|
||
```Bash | ||
cd backend | ||
``` | ||
|
||
Start the backend development server (typically using nodemon server.js or a similar command): | ||
|
||
```Bash | ||
npm run start | ||
``` | ||
|
||
## Project Structure | ||
|
||
### Project Structure | ||
``` | ||
StationGuide/ | ||
├── frontend/ | ||
|
@@ -97,12 +116,99 @@ StationGuide/ | |
└── ... # Other project configuration files (e.g., .gitignore) | ||
``` | ||
|
||
## How to Contribute | ||
|
||
Contributions are always welcome! | ||
To ensure a smooth collaboration process, Follow these steps: | ||
|
||
|
||
1. **Fork the Repository:** | ||
|
||
- Click the "Fork" button on the top right of the repository page. This creates a copy of the repository under your GitHub account. | ||
|
||
2. **Clone Your Fork:** | ||
|
||
- Run the following command in your terminal: | ||
```bash | ||
git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git | ||
``` | ||
- This command downloads your fork to your local machine. | ||
|
||
3. **Create a Branch:** | ||
|
||
- Navigate into the cloned repository: | ||
```bash | ||
cd Awesome-Github-Profiles | ||
``` | ||
- Create a new branch for your feature or fix: | ||
```bash | ||
git checkout -b your-feature-branch | ||
``` | ||
|
||
4. **Make Your Changes:** | ||
|
||
## Contributors ✨ | ||
- Implement your changes in your local repository. Make sure your code is clean and follows the project's coding style guidelines. | ||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
5. **Test Your Changes:** | ||
- If applicable, run tests to ensure that your changes do not break existing functionality. | ||
6. **Commit Your Changes:** | ||
- Commit your changes with a clear and descriptive message: | ||
```bash | ||
git commit -m "Add a feature or fix a bug" | ||
``` | ||
7. **Push to Your Fork:** | ||
- Push your changes back to your forked repository: | ||
```bash | ||
git push origin your-feature-branch | ||
``` | ||
8. **Create a Pull Request:** | ||
- Navigate to the original repository where you want to propose your changes. | ||
- Click on "New Pull Request" and follow the instructions to submit your changes for review. | ||
Please refer to the detailed [contribution guidelines](CONTRIBUTING.md) for more information. | ||
## Code of Conduct | ||
To foster a positive and inclusive community, please adhere to the following guidelines: | ||
- **Be Respectful:** Treat everyone with respect. Engage in constructive conversations. | ||
- **No Harassment:** Harassment, bullying, or discrimination will not be tolerated. | ||
- **Report Issues:** If you witness or experience any unacceptable behavior, please report it to the project maintainers. | ||
Please read the [code of Conduct](CODE_OF_CONDUCT.md) for more clear understanding. | ||
## How to Fork | ||
Forking allows you to create a personal copy of the repository, where you can experiment and make changes without affecting the original project. Here’s how to do it: | ||
### Navigate to the Repository: | ||
- Go to the Awesome GitHub Profiles repository. | ||
### Click on Fork: | ||
- On the top right corner, click the "Fork" button. | ||
### Select Your Account: | ||
- Choose your GitHub account to create the fork. | ||
### Clone Your Fork: | ||
- Use the command below to clone your fork to your local machine: | ||
```bash | ||
git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git | ||
``` | ||
## Contributors | ||
Thanks goes to these wonderful people ( [emoji key](https://allcontributors.org/docs/en/emoji-key) ): | ||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
<!-- prettier-ignore-start --> | ||
|
@@ -133,4 +239,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d | |
<!-- ALL-CONTRIBUTORS-LIST:END --> | ||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | ||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | ||
## Contact Information | ||
If you have questions, suggestions, or feedback, please reach out via email at [email protected]. You can also join our discussion forum [here](https://github.com/dhairyagothi/StationGuide/discussions). | ||
We value open communication and are happy to help! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.