Skip to content

KARTHIK-004/CPCL-FRONTEND

Repository files navigation

Here’s a professional README.md you can use for your CPCL-FRONTEND mobile app project (Expo/React Native) based on what’s visible in the repo (it’s an Expo project created with create-expo-app) and typical patterns for such apps. ([GitHub][1])


# CPCL Mobile App (Frontend)

A cross-platform **mobile application frontend** for Chennai Petroleum Corporation Limited (CPCL), built using **Expo (React Native)**.  
This app is part of the CPCL system and interacts with backend services to provide CPCL users with mobile access to core features.

> 📱 Built with Expo — works on **Android, iOS, and Web** (via Expo Go).

---

## 🚀 Features

- 📲 Cross-platform UI using React Native  
- ⚡ Fast development with Expo tooling  
- 🎨 Tailwind CSS for styling  
- 📁 Organized structure (app, assets, constants)  
- 📡 API communication (integrate later with CPCL backend)

---

## 📦 Tech Stack

| Technology | Purpose |
|------------|---------|
| **React Native** | UI framework |
| **Expo** | App build & development |
| **Tailwind CSS** | Styling |
| **JavaScript / JSX** | App logic |
| **ESLint / Prettier** | Code quality (optional) |

---

## 📁 Project Structure

├── app/ │ └── … # Source modules & screens ├── assets/images/ # Images & icons ├── constants/ # App constants & config ├── package.json ├── babel.config.js ├── tailwind.config.js ├── tsconfig.json └── eas.json # Expo Application Services config


---

## 🛠️ Setup & Installation

Make sure you have **Node.js**, **npm/yarn**, and **Expo CLI** installed.

1. **Clone the repo**
   ```sh
   git clone https://github.com/KARTHIK-004/CPCL-FRONTEND.git
   cd CPCL-FRONTEND
  1. Install dependencies

    npm install
    # or
    yarn install
  2. Start Expo

    npx expo start
  3. Use Expo Go on your phone or an emulator to run the app.


📱 Development

🧪 Run on device

  • Scan the QR in the Expo DevTools
  • Use Android Studio / iOS Simulator

🔁 Live reload

Code changes hot-reload automatically via Expo.


🧩 Environment Variables

If you plan to connect to backend APIs or use API keys:

  • Create a .env file

  • Add variables like:

    API_BASE_URL=https://api.cpcl.example
  • Install react-native-dotenv or similar if needed


📈 Next Steps / TODO

✅ Basic Expo project setup 🔲 Build screens & navigations 🔲 Integrate real CPCL backend APIs 🔲 Authentication support 🔲 State management (Redux / Context API) 🔲 Push notifications 🔲 Deployment to App Store & Play Store


🤝 Contributing

Contributions are welcome!

  1. Fork the project

  2. Create a feature branch

    git checkout -b feature/my-feature
  3. Commit & push

  4. Open a Pull Request


📄 License

This project is open-source (add your chosen license here, e.g., MIT)


About

Mobile frontend application for CPCL built using Expo and React Native, providing a platform solution for Android

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors