Tickets

📑 Table of Contents

• 📘 Introduction
• 🚀 Getting Started
  • Prerequisites ❗
  • Environment Variables 🔑
  • Setup ⬇️
  • Install ✔️
  • Usage 🤿 🏃‍♂️
• 🔍 API Reference
• 🏗️🔨 Architecture
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show Your Support
• 🔭 Up Next
• 💎 Lessons Learned

📘 Introduction

🚀 Getting Started

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

Prerequisites ❗

In order to run this project you need:

Environment Variables 🔑

To run this project, you will need to add the following environment variables to your secrets.yaml file

JWT_KEY : string, JSON web token secret (Example: JwtKey)

SALT_FACTORY: number of rounds to create salt for hashing ( Example: 10 )

STRIPE_KEY: your stripe API key to handle the payment

Note: All environment variables must be encoded in base64 format.

Setup ⬇️

1. Setup Ingress-Nginx Controller, refer to the documentation for instructions. This will guide you through the process of setting it up correctly to handle incoming traffic.

2. Clone this repository to to your preferred directory:

cd my-folder
git clone https://github.com/ahmedeid6842/Tickets.git

Install ✔️

Install this project with kubectl :

kubectl apply -f ./infra/k8s

Usage 🤿 🏃‍♂️

After following the above instructions, the Kubernetes cluster should be up and running.

• To verify the health of all Kubernetes cluster components and ensure that they are in a ready state, you can run the following command in the terminal:

kubectl get all

• Alright, it's showtime! 🔥 Hit ticketing.dev/api/users/currentuser and BOOM! 💥 You should see the microservices working like a charm. ✨🧙‍♂️

Note: the reason you are receiving {"currentUser":null} is because you are not currently logged in. However, this indicates that the services are operational and functioning properly.

🔍 API Refernce

Postman 🤩

Here is the link to the Postman documentation for Tickets: Postman Docs - Tickets.

🏗️🔨 Architecture

• Presented here is the general infrastructure diagram for the ticket cluster, illustrating the communication channels utilized by the distinct services to interoperate with one another.

👤 Author

Ahmed Eid 🙋‍♂️

• Github: @ahmedeid6842
• LinkedIn : Ahmed Eid
• Twitter: @ahmedeid2684

🤝 Contributing

We're always looking to improve this project! 🔍 If you notice any issues or have ideas for new features, please don't hesitate to submit a pull request 🙌 or create a new issue 💡. Your contribution will help make this project even better! ❤️ 💪

⭐️ Show your support

If you find this project helpful, I would greatly appreciate it if you could leave a star! 🌟 💟

🔭 Up next

• Implement validation for incoming requests 🚦
• Add automated testing for each microservice 🧪
• Implement "Forgot Password" functionality 💁

💎 Lessons Learned

1. Understanding of concurrency issues and techniques to mitigate them.

2. Development of a good interface and base classes using TypeScript to enhance code organization and reusability.

3. Configuration and use of a message broker to facilitate event sharing between microservices.

4. Creation of a robust architecture for the microservices cluster using Kubernetes.

5. There is always something new to learn 👨‍💻.