Skip to content

Latest commit

 

History

History
135 lines (96 loc) · 7.86 KB

README.md

File metadata and controls

135 lines (96 loc) · 7.86 KB

STATION GUIDE : YOUR PLATFORM GUIDE

All Contributors

All Contributors

Typing SVG welcome to repository of Station Guide

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

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:

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:
cd frontend
  • Start the frontend development server :
npm run dev

This will typically launch the React application on http://localhost:3000 (or the specified port) in your browser.

Backend:

  • Open another terminal or command prompt window (separate from the frontend window).
  • Navigate to the backend directory:
cd backend

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

npm run start

Project Structure

StationGuide/
├── frontend/
│   ├── src/  # React application source code
│   ├── public/  # Static assets for the frontend (e.g., images, fonts)
│   ├── package.json  # Frontend dependencies
│   └── ...  # Other frontend-related files (e.g., configuration files)
├── backend/
│   ├── server.js  # Express server entry point
│   ├── models/  # Data model definitions (optional)
│   ├── routes/  # API endpoints definitions
│   ├── config/  # Configuration files (e.g., database connection)
│   ├── package.json  # Backend dependencies
│   └── ...  # Other backend-related files (e.g., middleware)
├── .env  # Environment variables for sensitive information (optional)
├── using.md  # This file
└── ...  # Other project configuration files (e.g., .gitignore)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Dhairya Gothi
Dhairya Gothi

💻
Tarun Kumar
Tarun Kumar

💻
Shivani Nikam
Shivani Nikam

💻
Subham Singh
Subham Singh

💻
Prem Kolte
Prem Kolte

💻
Mihir Sai Dudekula
Mihir Sai Dudekula

💻
Riddhi M
Riddhi M

💻
Rishita Mehta
Rishita Mehta

💻
Shreya D
Shreya D

💻
Mrityunjay Singh
Mrityunjay Singh

💻

This project follows the all-contributors specification. Contributions of any kind welcome!