Skip to content

Commit

Permalink
minor fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Naveen-g09 committed Apr 14, 2024
1 parent ee29ae9 commit baf4975
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
---

# Expo App Starter

Welcome to Expo App Starter, a template repository designed to kickstart your app building journey with Expo! This repository comes fully equipped with all the prerequisites configured for seamless development. From Tailwind CSS integration to CI/CD pipelines, EAS build setup, GitHub actions, commit checks, pre-commit checks, type checking, and Expo router - everything you need is right here.
Expand Down Expand Up @@ -33,6 +31,40 @@ To work with this starter template, follow these basic steps:
- **Pre-commit Checks**: Validate all files to ensure they adhere to ESLint and type safety standards.
- **Type Safety Check and Format**: Run commands like `yarn format` to format files and `yarn pre-commit` to check file integrity.

## Setting Up Expo GitHub Actions

To set up Expo GitHub Actions in the terminal, follow these steps:

1. Create an Expo account and install EAS CLI on your computer:
```
npm install -g eas-cli
eas login
eas init
```

Follow the prompts, using your Expo account, and overwrite the key when prompted.

2. Generate a personal access token:
- Navigate to [Expo settings](https://expo.dev/settings/access-tokens).
- Click "Create token" to generate a new personal access token.
- Copy the token generated.

3. Add the access token as a secret in your GitHub repository:
- Navigate to `https://github.com/your-username/your-repo-name/settings/secrets/actions`, replacing "your-username" and "your-repo-name" with your project's info.
- Under "Repository secrets," click "New repository secret."
- Create a secret with the name `EXPO_TOKEN`, and paste the copied access token as the value.

These steps will set up GitHub Actions for your Expo project.

## Personalizing the App

To personalize the app:

- **Single Theme**: Change `userInterfaceStyle` in `app.json` from automatic to light or dark.
- **Replace Icon**: Replace `icon.png` with your image to get your own logo for the app. Note that it's the icon for iOS and adaptive icon for Android.

Hope this is useful and speeds up your journey, happy coding!

## Contributing

We welcome contributions from the community! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"main": "expo-router/entry",
"version": "1.0.0",
"scripts": {
"start": "expo start --dev-client",
"start": "expo start",
"dev": "expo start --dev-client",
"android": "expo run:android",
"ios": "expo run:ios",
"web": "expo start --web",
Expand Down

0 comments on commit baf4975

Please sign in to comment.