diff --git a/README.md b/README.md new file mode 100644 index 0000000..05580a0 --- /dev/null +++ b/README.md @@ -0,0 +1,131 @@ +

+

CareHelper 🏥

+ +

+ +

+ ava +

+ + +> CareHelper - A platform for patients and for doctors that helps the communication process between them more convenient during long-term examinations. + +This project will join [GDSC Solution Challenge 2024](https://developers.google.com/community/gdsc-solution-challenge). + +## Technology used ✨ + +- [Flutter & Dart](https://flutter.dev/) +- [React.js](https://reactjs.org/) +- [Firebase](https://firebase.google.com/) +- [NodeJs](https://nodejs.org/en) + + + +## Setup and run + +
+ Click to expand +
+

Clone the repo

+ +```sh +git clone https://github.com/dscdut/care-helper +``` + +

Backend

+ +1. Prerequisites + +- Install node + + +- Install yarn + +```sh +npm install --global yarn +``` + +2. Install NPM packages + +```sh +cd backend +# run database migrations and seeds +npm run db:reset +yarn install +``` + +3. Run the development server: + +```bash +yarn start +``` + +4. Open [http://localhost:3000](http://localhost:3000). + +

Mobile

+ + 1. Change directory: + + ```bash + cd .. + cd mobile + ``` + + 2. Get the dependencies: + + ```bash + flutter pub get + ``` + + 3. Start build APK release file: + + ```bash + flutter build apk --release -t lib/main_staging.dart --flavor=staging + ``` + + +

Frontend

+ +1. Install dependencies + +```sh +cd frontend +# run database migrations and seeds +npm run install +``` + +2. Run the development server: + +```bash +npm run dev +``` + +3. Open the running port + +