Project Name 🎈

Todo

• Update Project Name in README.md
• Update Project Name in CONTRIBUTING.md
• Update Project Name in CHANGELOG.md
• Update Project Name in VERSION.md
• Change MIT License to Internal Use License (IUL) and update in README.md
• Update Readme Badge URL
• Delete the Todo section

Introduction 📚

Deployment Details 🚀

• Node.js version: v20.3.1
• npm version: v9.7.2
• React version: 18.2.0
• React Native version: 0.72.1

Getting Started 🚦

The following instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Ensure you have Node.js, npm, and React Native installed on your system.

Installation

1. Clone the repository: git clone https://github.com/shiftboolean/<reponame>.git
2. Install the dependencies: npm install
3. Start the Metro Bundler: npm start
4. Run the app on Android: npm run android or on iOS: npm run ios

Project Structure 🏗️

The project follows a modular structure that separates different functionalities of the application into distinct sections. The directory structure is as follows:

.
├── src/                   # This directory contains all the application source code.
│   ├── App.tsx            # The entry point of the application.
│   ├── api/               # This directory contains all the API calls used in the application.
│   ├── components/        # This directory contains reusable components.
│   ├── navigation/        # This directory contains all navigation-related code.
│   ├── screens/           # This directory contains code for individual screens of the application.
│   ├── styles/            # This directory contains all the stylesheets or style-related code.
│   └── utils/             # This directory contains utility functions.
├── __tests__/             # This directory contains all the tests for the application.
├── android/               # This directory contains platform-specific code and configurations for Android.
├── ios/                   # This directory contains platform-specific code and configurations for iOS.
├── babel.config.js        # This file contains the configuration for Babel.
└── tsconfig.json          # This file contains the configuration for TypeScript.

src/: This directory contains all the application source code.

App.tsx: The entry point of the application.

api/: This directory contains all the API calls used in the application.

components/: This directory contains reusable components.

navigation/: This directory contains all navigation-related code.

screens/: This directory contains code for individual screens of the application.

styles/: This directory contains all the stylesheets or style-related code.

utils/: This directory contains utility functions.

__tests__/: This directory contains all the tests for the application.

android/ and ios/: These directories contain platform-specific code and configurations for Android and iOS respectively.

babel.config.js: This file contains the configuration for Babel, which is used to convert ECMAScript 2015+ code into a backwards compatible version of JavaScript.

tsconfig.json: This file contains the configuration for TypeScript, used to specify the root files and compiler options required to compile the project.

Usage 💻

After successfully running the app, you can open App.tsx and start building your application. Press the R key twice or select Reload from the Developer Menu to see your changes!

Contributing 🎁

We welcome contributions from the community. Please read our contribution guide for more information.

License 📄

This project is licensed under the MIT License - see the LICENSE.md file for details.

Website 🌐

For more information, visit shiftboolean.com