webapp-starter v1.0.12

Project Title

WebApp-Starter

Description

This template provides a ready-to-use Expo project with TypeScript, Mantine UI for styling, and Tailwind for easy and flexible styling. The project is set up to allow seamless development for both web and mobile platforms. It also gives you a web-first approach of building mobile applications.

Features

• Expo & TypeScript: A cross-platform Expo project written in TypeScript.
• Mantine UI: Styling and components are handled using Mantine UI, providing a modern and customizable design.
• Tailwind: Tailwind is integrated for effortless styling, enabling easy customization of styles.

Project Structure

Assets

• images: All project images should be stored here.
• IconImports.tsx: Manages icon imports using Expo-icons.

App

• components: Custom React components.
• screens: Application screens.
• utils: Utility functions.
• services: Service files for business logic.

Styles

Tailwind Configuration

• tailwind.config.js: Custom Tailwind configurations.

Usage

1. Clone the repository:

   git clone https://github.com/OATheSWE/WebApp-Starter.git

2. Install dependencies:

   cd WebApp-Starter
   yarn install

3. Run the project:

   yarn start

Additional Configurations

Tailwind Configuration

• Customize your Tailwind settings in tailwind.config.js.

Notes

• Regular CSS & CSS modules can be used in components due to Expo (metro config).

Web and App Display

• app.tsx: Displays content on the web.
• app.native.tsx: Displays content in a webview for mobile devices.

Both web and app have for real-time updates during development.

Documentation Links

• Mantine UI Documentation
• Expo Documentation
• React Native Documentation
• Tailwind Documentation

Feel free to customize this template to better suit your specific project details and style preferences.