Welcome to repository of Station Guide
-
To get to know about Station Guide Check : - StationGuide.md
-
To check UI Prototype Figma design :- StationGuideFigma.md
- Using Station Guide
- Getting Started
- Project Structure
- How to Contribute
- Code of Conduct
- How to Fork
- Contributors
- Contact Information
This project utilizes React for the frontend and Express for the backend, providing a robust foundation for your web application development.
To get started, you'll need the following:
- Node.js (version 14 or later): https://nodejs.org/en/
- npm (Node Package Manager) comes bundled with Node.js
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 :
- 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.
- 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
βββ CODE_OF_CONDUCT.md
βββ CONTRIBUTING.md
βββ LICENSE
βββ Learn.md
βββ README.md
βββ SECURITY.md
βββ StationGuide.md
βββ StationGuideFigma.md
βββ backend/
β βββ config/
β β βββ config.js
β β βββ dbConnection.js
β βββ controllers/
β β βββ StationController.js
β β βββ WheelchairController.js
β β βββ authController.js
β β βββ cloakroomController.js
β β βββ coolieController.js
β β βββ stationBookingsController.js
β β βββ stationsController.js
β βββ dataset/
β β βββ stations.js
β βββ dockerfile
β βββ index.js
β βββ middleware/
β β βββ auth.middleware.js
β βββ models/
β β βββ CloakroomBooking.js
β β βββ CoolieBooking.js
β β βββ Stations.js
β β βββ User.js
β β βββ WheelchairBooking.js
β βββ package-lock.json
β βββ package.json
β βββ public/
β β βββ test.html
β βββ routes/
β β βββ authRoutes.js
β β βββ stationRoutes.js
β βββ utils/
β βββ ApiError.js
β βββ asyncHandler.js
β βββ authFunctions.js
βββ docker-compose.yml
βββ frontend/
β βββ README.md
β βββ dockerfile
β βββ eslint.config.js
β βββ index.html
β βββ package-lock.json
β βββ package.json
β βββ postcss.config.js
β βββ public/
β β βββ vite.svg
β βββ src/
β β βββ App.css
β β βββ App.jsx
β β βββ Pages/
β β β βββ 3Dmaps.jsx
β β β βββ AboutUs.jsx
β β β βββ ContactUs.jsx
β β β βββ Emergency.jsx
β β β βββ ForaFriend.jsx
β β β βββ HelpandSupport.jsx
β β β βββ Herosection.css
β β β βββ Herosection.jsx
β β β βββ LoginPage.jsx
β β β βββ Payment.jsx
β β β βββ Register.jsx
β β β βββ booking.jsx
β β β βββ contributor.jsx
β β β βββ hamburger.css
β β β βββ hamburger.jsx
β β β βββ navigation.jsx
β β β βββ notification.jsx
β β β βββ schedule.jsx
β β β βββ stations.jsx
β β βββ assets/
β β β βββ bg.png
β β β βββ bgmobile.png
β β β βββ hero.png
β β β βββ mixbg.png
β β β βββ stationsaarthi.svg
β β β βββ svg/
β β β βββ 3dmap.svg
β β β βββ backicon.svg
β β β βββ bookings.svg
β β β βββ chatbot.svg
β β β βββ contributor.svg
β β β βββ navigation.svg
β β β βββ notification.svg
β β β βββ schedule.svg
β β β βββ search.svg
β β β βββ station.svg
β β βββ components/
β β β βββ Bookingform.jsx
β β β βββ MapComponent.jsx
β β β βββ Settings.jsx
β β β βββ about.css
β β β βββ about.jsx
β β β βββ chatbot.css
β β β βββ chatbot.jsx
β β β βββ footer.jsx
β β β βββ help.jsx
β β β βββ navbar.jsx
β β β βββ scrollToTop.css
β β β βββ scrollToTop.jsx
β β βββ dataset/
β β β βββ stations.js
β β βββ index.css
β β βββ main.jsx
β β βββ validations/
β β βββ validation.js
β βββ tailwind.config.js
β βββ vite.config.js
βββ notification_system/
β βββ backend/
β β βββ config/
β β β βββ db.js
β β βββ controllers/
β β β βββ notificationController.js
β β βββ models/
β β β βββ Notification.js
β β β βββ User.js
β β βββ package.json
β β βββ routes/
β β β βββ notificationRoutes.js
β β β βββ userRoutes.js
β β βββ server.js
β β βββ services/
β β βββ emailServices.js
β βββ frontend/
β βββ package.json
β βββ public/
β β βββ service-worker.js
β βββ src/
β βββ app.js
β βββ components/
β β βββ NotificationCentre.js
β β βββ NotificationSettings.js
β βββ index.js
βββ package-lock.json
βββ package.json
βββ repo_structure.txt
βββ tailwind.config.js
Contributions are always welcome! To ensure a smooth collaboration process, Follow these steps:
-
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.
-
Clone Your Fork:
- Run the following command in your terminal:
git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git
- This command downloads your fork to your local machine.
- Run the following command in your terminal:
-
Create a Branch:
- Navigate into the cloned repository:
cd Awesome-Github-Profiles
- Create a new branch for your feature or fix:
git checkout -b your-feature-branch
- Navigate into the cloned repository:
-
Make Your Changes:
- Implement your changes in your local repository. Make sure your code is clean and follows the project's coding style guidelines.
-
Test Your Changes:
- If applicable, run tests to ensure that your changes do not break existing functionality.
-
Commit Your Changes:
- Commit your changes with a clear and descriptive message:
git commit -m "Add a feature or fix a bug"
- Commit your changes with a clear and descriptive message:
-
Push to Your Fork:
- Push your changes back to your forked repository:
git push origin your-feature-branch
- Push your changes back to your forked repository:
-
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 for more information.
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 for more clear understanding.
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:
- Go to the Awesome GitHub Profiles repository.
- On the top right corner, click the "Fork" button.
- Choose your GitHub account to create the fork.
- Use the command below to clone your fork to your local machine:
git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git
Dhairya Gothi Project Admin |
If you have questions, suggestions, or feedback, please reach out via email at [email protected]. You can also join our discussion forum.
We value open communication and are happy to help!
If you find this project helpful, please consider giving it a β on GitHub! Your support helps to grow the project and reach more contributors.