lokesh1jha / devswad-app

DevSwaD App is a React Native mobile application for an e-commerce platform specializing in authentic Bihari cuisine products. This app allows users to browse, purchase, and learn about traditional Bihari food items.
1 stars 0 forks source link
e-commerce react-native react-native-app

DevSwaD App

Table of Contents

Introduction

DevSwaD App is a React Native mobile application for an e-commerce platform specializing in authentic Bihari cuisine products. This app allows users to browse, purchase, and learn about traditional Bihari food items.

Features

Prerequisites

Before you begin, ensure you have met the following requirements:

Installation

To install DevSwaD App, follow these steps:

  1. Clone the repository:

git clone https://github.com/lokesh1jha/devswad-app.git


2. Navigate to the project directory:

cd devswad-app


3. Install dependencies using Yarn:

yarn install


## Usage

To run the app locally:

1. Start the development server:

yarn start


2. Use the Expo Go app on your mobile device to scan the QR code, or press 'i' for iOS simulator or 'a' for Android emulator.

## Project Structure

devswad-app/ ├── src/ │ ├── components/ │ ├── screens/ │ ├── navigation/ │ ├── hooks/ │ ├── utils/ │ └── types/ ├── App.tsx ├── app.json ├── babel.config.js ├── package.json └── tsconfig.json


## Contributing

To contribute to DevSwaD App, follow these steps:

1. Fork the repository.
2. Create a new branch: `git checkout -b <branch_name>`.
3. Make your changes and commit them: `git commit -m '<commit_message>'`.
4. Push to the original branch: `git push origin <project_name>/<location>`.
5. Create the pull request.

Alternatively, see the GitHub documentation on [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

## Testing

To run tests:

yarn test


## Deployment

To build the app for production:

1. For Android:

yarn android:build


2. For iOS:

yarn ios:build


Follow the Expo documentation for detailed instructions on building and publishing your app.

## Built With

- [React Native](https://reactnative.dev/) - The mobile application framework
- [Expo](https://expo.dev/) - Development platform for React Native
- [React Navigation](https://reactnavigation.org/) - Routing and navigation
- [React Native Elements](https://reactnativeelements.com/) - UI component library
- [TypeScript](https://www.typescriptlang.org/) - Static type checking

## License

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

## Contact

If you have any questions or comments about the project, please contact:

DevSwaD Team - info@devswad.com

Project Link: [https://github.com/lokesh1jha/devswad-app](https://github.com/lokesh1jha/devswad-app)

This README provides a comprehensive overview of the DevSwaD App project, including setup instructions, contribution guidelines, and other relevant information. You may need to adjust some details (such as the GitHub repository URL) to match your specific project setup.

Remember to create and maintain other documentation files as needed, such as a CONTRIBUTING.md for more detailed contribution guidelines, or a CHANGELOG.md to track version changes.