Skip to content

README.md

Latest commit

 

History

History
68 lines (52 loc) · 2.3 KB

README.md

File metadata and controls

68 lines (52 loc) · 2.3 KB
Raw

Here is the complete, consolidated README.md file. It incorporates your latest cleanup, updates the Folder Structure to accurately reflect your current directory, and ensures the repo links match your terminal path.

# TeachLink Mobile

This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).

## Get started

1. **Install dependencies**

   ```bash
   npm install

  1. Start the app

    npx expo start

In the output, you'll find options to open the app in a:

You can start developing by editing the files inside the app directory. This project uses file-based routing.

Get a fresh project

When you're ready, run:

git clone [https://github.com/rinafcode/teachLink_mobile.git](https://github.com/rinafcode/teachLink_mobile.git)
cd teachLink_mobile
cp .env.example .env
npm install
npx expo start

Features

  • Cross-platform (iOS & Android)
  • Share and browse knowledge content
  • Live chat and push notifications
  • Earn from your contributions
  • Dark/light mode

Folder Structure

.
├── app/                # Expo Router: File-based routing & layouts
├── assets/             # Media (Images, Fonts, Icons)
├── components/         # Reusable UI components
├── constants/          # App-wide constants (Colors, API endpoints)
├── docs/               # Project documentation & troubleshooting logs
├── hooks/              # Custom React hooks
├── scripts/            # Build and maintenance scripts
├── src/                # Shared business logic and services
├── app.json            # Expo configuration
├── tailwind.config.js  # NativeWind styling configuration
└── tsconfig.json       # TypeScript configuration

Resources