Readme.md

Uber-Like App🚘

This repository contains the codebase for an Uber-like application providing both delivery and cab services. The project uses modern technologies including Docker, Kubernetes, TypeScript for backend, React for frontend, GraphQL for API interactions, Redis for caching, Kafka for message brokering, and advanced routing algorithms.

Repository Owner

This repository is maintained by Vishesh Rawal.

LinkedIn Profile : LinkedIn.

🔗 Important Links 🔗

Join our Official Discord Server

---

📑 For Table of Contents

1. Navigate to the top-right corner of the Readme file.
2. Click on the list-view(three horizontal lines and three vertical dots) icon.
3. A dropdown will appear with the Table of Contents.

---

📋 Participating Programs

Name	Logo	Purpose
GSSoC'2024-Extd		The coding period is from October 1st to October 30th, during which contributors make contributions and earn points on the platform.
Hacktoberfest 2024		Hacktoberfest is a month-long October event welcoming all skill levels to join the open-source community.

---

📂Project Structure

uber-like-app/
├── frontend/
│ ├── Dockerfile
│ └── src/
├── backend/
│ ├── Dockerfile
│ ├── src/
│ ├── package.json
│ ├── tsconfig.json
│ └── nodemon.json
├── kubernetes/
│ ├── deployment.yaml
│ ├── service.yaml
│ └── ingress.yaml
├── .github/
│ └── workflows/
│ └── ci-cd.yml
├── .dockerignore
├── .gitignore
├── README.md
└── docker-compose.yml

⚙️CI/CD Pipeline

The CI/CD pipeline is set up using GitHub Actions. It builds and deploys Docker images for the frontend and backend services and deploys them to a Kubernetes cluster.

🔗 Setup Instructions

📝Prerequisites

• Docker
• Kubernetes
• GitHub account
• DockerHub account

🚀 How to Contribute to This Project 🚀

We’re excited to have you contribute to this Ice Cream Parlour Website project! Follow these simple steps to get started:

1. 🍴 Fork the Repository

   • Go to the repository page.
   • Click the Fork button (top right). This creates a copy of the project in your GitHub account.

2. 💻 Clone Your Fork

   • Once the repository is forked, clone it to your local machine. Open your terminal and run:

    git clone https://github.com/your-username/Uber-like.git
   cd uber-like

   • Replace your-username with your GitHub username.

3. 🌿 Create a New Branch

   • Before making any changes, create a new branch for your work:

    git checkout -b your-branch-name

   • Choose a branch name that describes what you're working on, such as fix-navbar or add-contact-form.

4. 🛠️ Make Your Changes

   • Open the project files in your code editor (like VS Code) and make your changes.
   • You can contact the project manager for any queiries you have.

5. ✅ Test Your Changes

   • Make sure your changes work correctly by testing the website locally. Open the index.html file in your browser to see your updates.

6. 💬 Commit Your Changes

   • Once your changes are ready, commit them with a descriptive message:

     git add .
     git commit -m "Added feature X or Fixed issue Y"

7. 📤 Push Your Changes

   • Push your changes to your forked repository on GitHub:

    git push origin your-branch-name

8. 🔄 Create a Pull Request (PR)

   • Go back to the original repository here.
   • Click the Compare & pull request button.
   • Write a short description of your changes and submit the pull request (PR).

9. 🔎Review Changes

   • The project manager will review your PR. If your changes are approved, your request would be merged.

---

By following these steps, you can easily contribute to this project! If you have any questions, feel free to ask in the repository’s discussion or issue section.

✅Run Locally with Docker Compose

docker-compose up --build

🔄Deploy to Kubernetes

kubectl apply -f kubernetes/

📢Our Valuable Contributors📢

---

Stargazers ❤️

Forkers ❤️

---

📃LICENSE

This project is licensed under the MIT License - see the MIT License file for details.

Additional Recommendations

• 📝Testing: Implement unit and integration tests for both frontend and backend.
• 📈Monitoring: Set up Prometheus and Grafana for monitoring the application.
• 🛡️Security: Regularly audit the codebase for security vulnerabilities.

By following these steps, you will set up a comprehensive repository with all the necessary components for the project, including a CI/CD pipeline, Docker configuration, and Kubernetes deployment files. This will ensure a robust, scalable, and maintainable application architecture.