Skip to content

Commit a278fa9

Browse files
authored
Create README.md
1 parent ae68be0 commit a278fa9

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

README.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# ADPC IoT Mobile App
2+
3+
## Summary
4+
5+
The ADPC IoT Mobile App is a prototype application designed to facilitate interaction with IoT devices via Bluetooth Low Energy (BLE). It enables users to send and withdraw consents for data privacy directly from their mobile devices. Featuring a user-friendly interface that aligns with the design standards of modern mobile applications, the app enhances user interaction with IoT devices. Additionally, it explores the integration of Large Language Models (LLMs) through OpenAI's ChatGPT API, initially focusing on simplifying consent requests from IoT devices. The app's potential future expansions could further leverage LLMs to unlock new capabilities. The ADPC IoT Mobile App supports both iOS and Android platforms, ensuring a wide reach across different devices.
6+
7+
## Installation Requirements
8+
9+
Before you can run the ADPC IoT Mobile App, ensure you have the following installed:
10+
11+
- **Expo CLI**: Essential for running and testing the app.
12+
- **Expo Go**: Install this on your phone for live testing.
13+
- **NPM**: Node Package Manager, crucial for managing the app's dependencies.
14+
- **React Native**: The framework used for developing the application.
15+
16+
### Setting Up Your Environment
17+
18+
Install Node.js and NPM: Download and install Node.js from its official website. NPM comes bundled with Node.js.
19+
20+
Expo CLI Installation:
21+
22+
```bash
23+
npm install -g expo-cli
24+
```
25+
26+
Download Expo Go: Navigate to your respective app store on your mobile device and search for "Expo Go" to download and install it.
27+
28+
#### Clone the Project:
29+
Clone the repository to your local machine using:
30+
31+
```bash
32+
git clone <repository-url>
33+
```
34+
35+
#### Install Project Dependencies:
36+
Navigate to the project directory and run:
37+
38+
```bash
39+
npm install
40+
```
41+
42+
This command installs all necessary dependencies listed in the project's package.json file.
43+
44+
## Testing the App
45+
46+
To test the app on your development environment, you can use the following commands:
47+
48+
For Android:
49+
```bash
50+
npx expo run:android
51+
```
52+
53+
For iOS:
54+
```bash
55+
npx expo run:ios
56+
```
57+
58+
## Testing on Emulators
59+
60+
To simulate the app on virtual devices, ensure you have:
61+
62+
Android Studio: For Android emulator setup.
63+
Xcode: For iOS simulator setup.
64+
Note: For testing Bluetooth capabilities, a physical device is necessary, as emulators do not emulate Bluetooth functionality.
65+
66+
## Future Research and Development
67+
68+
Future iterations of the ADPC IoT Mobile App may explore additional uses of Large Language Models to enhance the interaction between users and IoT devices, capitalizing on the vast potential of these technologies for improving user experience and consent management.
69+
70+
## Contributing
71+
72+
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
73+
74+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
75+
76+
Don't forget to give the project a star! Thanks again!
77+
78+
- Fork the Project
79+
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
80+
- Commit your Changes (git commit -m 'Add some AmazingFeature')
81+
- Push to the Branch (git push origin feature/AmazingFeature)
82+
- Open a Pull Request
83+
84+
## License
85+
86+
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

0 commit comments

Comments
 (0)