https://github.com/ppenter/aphasia-react
https://github.com/ppenter/aphasia-react
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ppenter/aphasia-react
- Owner: ppenter
- Created: 2023-09-28T08:12:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T09:15:28.000Z (over 1 year ago)
- Last Synced: 2025-02-02T06:42:07.220Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://aphasia-react-phpx.vercel.app
- Size: 20.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AphasiaTalk
AphasiaTalk is a cross-platform application built using CapacitorJS and Yarn. It allows you to develop, build, and export your application to various platforms (iOS, Android, Web) seamlessly.
# Table of Contents
- [AphasiaTalk](#aphasiatalk)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Development](#development)
- [Building and Exporting](#building-and-exporting)
- [Additional Capacitor Commands](#additional-capacitor-commands)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Prerequisites
- Node.js (>= 20)
- Yarn (>= 2.x)
- [Capacitor CLI](https://capacitorjs.com/docs/getting-started) (>= 5.x)
- Gradle 17.0.11
_Ensure you have these tools installed before proceeding._
## Getting Started
### Installation
To get started, clone the repository and install the dependencies using Yarn:
```bash
yarn install
```
This will install all the necessary packages required for the project.
### Development
To start the development server and begin working on the application:
```bash
yarn dev
```
This will start a local development server, allowing you to view your application in the browser with live reloading.
### Building and Exporting
To build the application and prepare it for deployment on various platforms, use the following command:
```bash
yarn export
```
This command will:
- Build the project
- Copy the built assets to the Capacitor native projects
- Sync the changes with the native projects
Internally, yarn export runs the following commands:
```bash
yarn build && npx cap copy && npx cap sync
```
### Additional Capacitor Commands
You may need to run additional Capacitor commands depending on your specific use case. Here are a few commonly used ones:
Open the iOS project in Xcode:
```bash
npx cap open ios
```
Open the Android project in Android Studio:
```bash
npx cap open android
```
Update Capacitor plugins:
```bash
npx cap update
```
## Project Structure
- `src/`: Contains the source code for your application.
- `public/`: Contains static assets and the main HTML file.
- `android/`: Android native project.
- `ios/`: iOS native project.
## Contributing
If you would like to contribute to this project, please fork the repository and create a pull request with your changes. Ensure that your code adheres to the project's coding standards and include relevant tests.
## License
This project is licensed under the MIT License. See the LICENSE file for more details.
## Contact
For any inquiries or support, please contact [jarupak.sri@gmail.com].