- Introduction
- Features
- Prerequisites
- Installation
- Usage
- Project Structure
- Contributing
- Testing
- Deployment
- Built With
- License
- Contact
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.
- Browse products by category
- View detailed product information
- Add items to cart
- Manage shopping cart
- Place orders
- View order history
- User authentication
- About and Contact pages
Before you begin, ensure you have met the following requirements:
- Node.js (v14.0.0 or later)
- Yarn (v1.22.0 or later)
- Expo CLI (v4.0.0 or later)
- iOS Simulator or Android Emulator (for local development)
To install DevSwaD App, follow these steps:
- Clone the repository:
git clone [https://github.com/lokesh1jha/devswad-app.git](https://github.com/lokesh1jha/devswad-app.git)
- Navigate to the project directory:
cd devswad-app
- Install dependencies using Yarn:
yarn install
To run the app locally:
- Start the development server:
yarn start
- 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.
devswad-app/
├── src/
│ ├── components/
│ ├── screens/
│ ├── navigation/
│ ├── hooks/
│ ├── utils/
│ └── types/
├── App.tsx
├── app.json
├── babel.config.js
├── package.json
└── tsconfig.json
To contribute to DevSwaD App, follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
. - Push to the original branch:
git push origin <project_name>/<location>
. - Create the pull request.
Alternatively, see the GitHub documentation on creating a pull request.
To run tests:
yarn test
To build the app for production:
- For Android:
yarn android:build
- For iOS:
yarn ios:build
Follow the Expo documentation for detailed instructions on building and publishing your app.
- React Native - The mobile application framework
- Expo - Development platform for React Native
- React Navigation - Routing and navigation
- React Native Elements - UI component library
- TypeScript - Static type checking
This project is licensed under the MIT License - see the LICENSE.md file for details.
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
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.