Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
75 changes: 69 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,82 @@
# gluestack-ui Starter Kit

## Installation
Welcome to the gluestack-ui Starter Kit! This project is designed to help you kickstart your application development with React and React Native. It supports both Next.js and Expo, providing a flexible and modular architecture.

## Getting Started

### Installation

1. Clone the repository:

```bash
https://github.com/gluestack/gluestack-ui-starter-kits.git
```

2. Install dependencies:

Go to `expo-app`, `next` and `universal` folders and run the following command:

```bash
yarn
```

### Running the Application

#### Next.js

To run the Next.js application, run the following command:

```bash
cd next && yarn dev
```

#### Expo

To run the Expo application, run the following command:

```bash
cd starter-kit && yarn
cd expo-app && yarn start
```

## Run Expo
#### Universal

To run expo app, run the following command:

```bash
cd starter-kit && yarn run:expo
cd universal && yarn run:expo
```

## Run Next.js app
To run next app, run the following command:

```bash
cd universal && yarn run:next
```

## Project Structure

### Next.js

- `next`: Contains the Next.js application along with components and screens.

### Expo

- `expo`: Contains the Expo application along with components and screens.

### Universal

- `app/next`: Contains the Next.js application.
- `app/expo`: Contains the Expo application.
- `packages/components`: Shared components used across platforms.
- `packages/screens`: Shared screens that can be used in both Next.js and Expo projects.

# Usage

You can copy project of your choice and start building your application.

# Ejection

If you have copied the universal project and want to eject the project, you can run the following command:

```bash
cd starter-kit && yarn run:next
cd universal && yarn eject
```
9 changes: 9 additions & 0 deletions expo-app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

# @generated expo-cli sync-2b81b286409207a5da26e14c78851eb30d8ccbdb
# The following patterns were generated by expo-cli

expo-env.d.ts
# @end expo-cli
node_modules
.expo
dist
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const imageBabel = require("@unitools/babel-plugin-universal-image");
const path = require("path");

module.exports = function (api) {
api.cache(true);
return {
Expand All @@ -20,7 +22,7 @@ module.exports = function (api) {
[
imageBabel,
{
assetPath: "assets",
assetPath: path.join(__dirname, "assets"),
},
],
"react-native-reanimated/plugin",
Expand Down
Loading