Telco Customer Churn

A minimalistic telco customer churn predictor. 🚀

View | Pulls | Issues | License

---

This repository contains the Frontend for the project, to view the backend, visit the Backend Repository, maintained by Abhinn Verma. ✨

Frontend Tech Stack:

• Vite.js for building & deploying the application.
• React.js for handling transitions & components.
• Tailwind for adding styles to the application.
• Chart.js for rendering dynamic charts and figures.
• Zod for form validation & XSS security.

Additional Dev Tools:

• Bun for testing, bundling & managing dependencies.
• ESLint for improving overall code quality.

This project is LIVE with the help of Vercel & Render! 🥂

---

📂 Running the project locally

First, clone & prepare the Frontend repository.

git clone https://github.com/v1br/telco-churn.git telco-front
cd telco-front/web
bun install

Then, clone & prepare the Backend repository.

git clone https://github.com/AbhinnV04/Customer_Churn_Telco.git telco-back
cd telco-back
python -m venv venv
venv\Scripts\activate # on windows only
source venv/bin/activate # on macos & linux only
pip install -r requirements.txt

Update the env in both repositories.

• Set telco-front/web/.env to track backend URL.
• Set telco-back/.env to track frontend URL.

Finally, run the development environments for both.

bun run dev # inside telco-front/web
fastapi dev main.py # inside telco-back

---

💻 Contributing to the project

To contribute to the Frontend repository, follow these steps.

# [ fork the repository ]
git clone https://github.com/user/telco-churn.git && cd telco-churn
git branch -b new-feature
cd web && bun install
# [ apply your changes ]
bun run lint
# [ fix lint errors ]
git add changes
git commit -m "meaningful message"
git push origin new-feature
# [ create a pull request ]

Important

Please follow conventional commits.

---