-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
1,767 additions
and
272 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,97 @@ | ||
# matadors-rn-medica | ||
# Medica App | ||
|
||
Online Doctor Appointment & Consultation App | ||
|
||
## Table Of Content | ||
|
||
- [Description](#description) | ||
|
||
- [Documentation](#documentation) | ||
- [Setup](#setup) | ||
- [Testing](#testing) | ||
- [Contribute](#contribute) | ||
- [Contact](#contact) | ||
- [License](#license) | ||
|
||
|
||
## Description | ||
|
||
Medica is a mobile application designed to facilitate online doctor appointments and consultations. Users can create an account, log in, browse through various doctor specialties, schedule appointments, and communicate with healthcare professionals through voice calls, video calls, or messaging. The app also supports different payment methods for appointment fees, provides access to healthcare articles, allows profile management, and offers a help center for user support. | ||
|
||
## Overview; | ||
None at the moment!! | ||
|
||
## Documentation | ||
|
||
### Endpoints | ||
|
||
- `/signup`: User signup endpoint | ||
- `/login`: User login endpoint | ||
- `/ForgotPassword`: Ask for password Retrieval or reset if forgot | ||
- `/ResetPassword`: Access to Changing the users Password | ||
- `/Home`: List of available doctor specialties | ||
- `/search`: Search for doctors across all specialties | ||
- `/appointments`: Schedule and manage appointments | ||
- `/communication`: Choose communication mode (voice call, video call, messaging) | ||
- `/payment`: Select and process payment for appointments | ||
- `/articles`: Access and interact with healthcare articles | ||
- `/profile`: Manage user profile | ||
- `/help`: Contact the help center | ||
|
||
|
||
## Setup | ||
|
||
### Dependencies | ||
|
||
- Node.js | ||
- React Native | ||
- Expo (for mobile app development) | ||
|
||
### Getting Started | ||
|
||
1. Clone the repository: | ||
git clone https://github.com/atlp-rwanda/matadors-rn-medica.git | ||
|
||
2. Navigate to the project directory: | ||
|
||
3. Install dependencies: | ||
```bash | ||
npm install | ||
``` | ||
5. Set up environment variables: | ||
- Create a `.env` file based on `.env.example` and fill in necessary values. | ||
|
||
### Run The Service | ||
|
||
1. Start the Expo development server: | ||
```bash | ||
npm start | ||
``` | ||
2. Use the Expo client on your mobile device or simulator to run the app. | ||
|
||
## Testing | ||
|
||
To run tests, use the following command: | ||
```bash | ||
npm test | ||
``` | ||
## Contribute | ||
|
||
Contributions are welcome! To contribute to this repository, please follow these steps: | ||
1. Fork the repository. | ||
2. Create a new branch (`git checkout -b feature/my-feature`). | ||
3. Commit your changes (`git commit -am 'Add new feature'`). | ||
4. Push to the branch (`git push origin feature/my-feature`). | ||
5. Create a new Pull Request. | ||
|
||
|
||
## Contact | ||
|
||
Feel free to reach out to us: | ||
[Nkbtemmy](https://github.com/Nkbtemmy) | ||
[mukunzidd](https://github.com/mukunzidd) | ||
|
||
## License | ||
|
||
None At the moment !! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import globals from "globals"; | ||
import pluginJs from "@eslint/js"; | ||
import tseslint from "typescript-eslint"; | ||
import pluginReactConfig from "eslint-plugin-react/configs/recommended.js"; | ||
|
||
|
||
export default [ | ||
{languageOptions: { globals: globals.browser }}, | ||
pluginJs.configs.recommended, | ||
...tseslint.configs.recommended, | ||
pluginReactConfig, | ||
]; |
Oops, something went wrong.