Skip to content

Nassim84/frontend-gocar

Repository files navigation

🚗 Gocar Frontend

Welcome to the Gocar frontend repository! This project is part of a carpooling service built with modern web technologies.

🌐 Project Overview

Gocar is a carpooling platform designed to make it easy for people to share rides. The frontend is built using the following technologies:

  • React ⚛️
  • Vite ⚡️
  • TypeScript 🟦

🛠️ Technologies Used

  • React: A JavaScript library for building user interfaces.
  • Vite: A fast development build tool and dev server.
  • TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.

📂 Project Structure

Project Structure

Here's a brief overview of the project's structure:

├── public/               # Static assets
│
├── src/                  # Source files
│   ├── components/       # React components
│   ├── config/           # Configuration files
│   ├── contexts/         # Context providers
│   ├── pages/            # Page components
│   ├── services/         # Service utilities
│   ├── styles/           # Styling files
│   ├── App.tsx           # Main app component
│   ├── main.tsx          # Entry point
│   └── ...               # Other folders and files
│
├── .gitignore            # Git ignore file
├── package.json          # Project metadata and dependencies
├── tsconfig.json         # TypeScript configuration
└── vite.config.ts        # Vite configuration


🚀 Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have Node.js and npm (or yarn) installed on your machine.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/Gocar-frontend.git
    cd Gocar-frontend
  2. Install dependencies:

    npm install

    or

    yarn install

Running the Project

To start the development server, run:

npm run dev

or

yarn dev

The app will be available at http://localhost:5173.

📦 Building for Production To create a production build, run:

npm run build

or

yarn build

The build will be stored in the dist directory.

🤝 Contributing Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project Create your Feature Branch (git checkout -b feature/AmazingFeature) Commit your Changes (git commit -m 'Add some AmazingFeature') Push to the Branch (git push origin feature/AmazingFeature) Open a Pull Request 📝 License Distributed under the MIT License. See LICENSE for more information.

📧 Contact Your Name - [email protected]

Project Link: https://github.com/your-username/Gocar-frontend

Thank you for checking out Gocar! Happy coding! 🚀

Releases

No releases published

Packages

No packages published

Languages