Skip to content

yarkhan706/NTUMAI

Repository files navigation

NTUMAI

A sleek and modern React Native mobile application built with TypeScript and styled using Tailwind CSS (via NativeWind). This project demonstrates an onboarding experience and scalable UI architecture designed for rapid development and maintainability.


🌟 Features

  • 🧠 TypeScript – Type-safe development
  • 🎨 Tailwind CSS (NativeWind) – Utility-first styling for React Native
  • 📱 React Native – Cross-platform app development
  • 🔧 Modular codebase structure
  • 📦 Ready-to-deploy mobile architecture


🛠️ Tech Stack

Technology Description
React Native Cross-platform mobile app framework
TypeScript Typed superset of JavaScript
NativeWind Tailwind CSS for React Native
Expo (optional) Toolchain for React Native development

📂 Folder Structure

NTUMAI/
├── assets/                 # Static files (images, fonts, etc.)
├── screens/                # All screen components
│   └── Onboarding/         # Onboarding screen UI
├── App.tsx                 # App entry point
├── app.json                # App configuration
├── babel.config.js         # Babel setup
├── global.css              # Global styles
├── index.ts                # React Native entry
├── metro.config.js         # Metro bundler config
├── nativewind-env.d.ts     # Type support for NativeWind
├── package.json            # NPM scripts & dependencies
├── postcss.config.js       # PostCSS setup
├── tailwind.config.js      # Tailwind theme configuration
├── tsconfig.json           # TypeScript compiler options
└── .gitignore              # Files to ignore by git

## 🚀 Getting Started

### 📦 Prerequisites

Ensure you have the following installed:

- [Node.js](https://nodejs.org/) ≥ 14  
- npm or yarn  
- [Expo CLI](https://docs.expo.dev/workflow/expo-cli/) (if using Expo)  
- Android Studio / Xcode for emulation (or Expo Go)

---

### 🔧 Installation

#### 1. **Clone the repo**

```bash
git clone https://github.com/yarkhan706/NTUMAI.git
cd NTUMAI

2. Install dependencies
bash
Copy
Edit
npm install
# or
yarn install
3. Start the development server
bash
Copy
Edit
npm start
# or
yarn start
4. Run on device
Use the Expo Go app to scan the QR code

Or run on emulator via Expo or Android Studio

📘 Usage
This app currently features an onboarding flow. You can navigate through screens defined in the screens/ directory. Customize or add new screens by extending this modular architecture.

🙋‍♂️ Author
Developed with ❤️ by @yarkhan706

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors