diff --git a/README.md b/README.md index f923a03..dcf2b0c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,43 @@ -Expo-App-Starter --- -this is a template repository for quick starter of app building with expo. -this has all the pre requisites configured for using tailwind, CI/CD pipeline, eas build, github action, commit check, pre commit check, type check, expo router and all. -follow basic steps below by cloning, and configuring \ No newline at end of file + +# 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. + +## Prerequisites + +Before getting started, ensure you have the following installed: + +- [Node.js](https://nodejs.org/) +- [Yarn](https://yarnpkg.com/) +- [EAS (Preferred)](https://docs.expo.dev/build/introduction/) +- [Expo account](https://expo.dev/) + +## Getting Started + +To work with this starter template, follow these basic steps: + +1. **Fork** this repository to your own GitHub account. +2. **Clone** the forked repository locally to your development environment. +3. **Navigate** into the cloned repository directory. +4. Run `yarn` to install all necessary dependencies. (Note: Yarn is also used for installation in GitHub actions. If you prefer using npm, update the configurations in `.github\workflows\preview.yml` and `.github\workflows\update.yml`). +5. Start your application by running `yarn start`. This will launch your application, and you can access it through the Expo Go app. + +## Features + +- **Tailwind CSS Integration**: Tailwind CSS is pre-configured for effortless styling. +- **CI/CD Pipelines**: Continuous Integration and Continuous Deployment pipelines are set up for streamlined development workflows. +- **EAS Build Setup**: Easily configure and build your Expo projects using Expo Application Services. +- **GitHub Actions**: Automated workflows using GitHub Actions ensure efficient development processes. +- **Commit Checks**: Automated checks are in place to ensure high-quality commits. +- **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. + +## 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. + +## License + +This project is licensed under the [MIT License](LICENSE). +