https://github.com/ohcnetwork/ayushma_fe
https://github.com/ohcnetwork/ayushma_fe
hacktoberfest nextjs react
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ohcnetwork/ayushma_fe
- Owner: ohcnetwork
- License: mit
- Created: 2023-04-24T05:13:09.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T06:17:13.000Z (over 1 year ago)
- Last Synced: 2025-04-09T03:15:40.300Z (about 1 year ago)
- Topics: hacktoberfest, nextjs, react
- Language: TypeScript
- Homepage: https://ayushma.ohc.network
- Size: 4.24 MB
- Stars: 4
- Watchers: 5
- Forks: 13
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Ayushma is a digital AI health and nursing assistant to help Nurses and Doctors in the most remote parts of the world. It is a part of the Open Health Care Network
🚀 Staging Deployment
Auto deployed to ayushma.ohc.network for production branch. All pull requests have preview builds powered by Vercel.
## Getting started
- 💬 Comment on the issue if you are willing to take it up, and link the pull request with the issue.
- 📸 Attach screenshots in the pull requests showing the changes made in the UI.
#### Install the required dependencies
```sh
pnpm i
```
#### 🏃 Run the app in development mode
```sh
pnpm dev
```
Once the development server has started, open [localhost:3000](http://localhost:3000) in your browser. The page will be automatically reloaded when you make edits and save. You will also see any lint errors in the console.
#### 🔑 Staging API Credentials
Authenticate to staging API with the following credentials
```yaml
- email: demo@ayushma.ohc.network
password: Demo@Ayu
```
You can also register as a new user.
#### 🏷️ Make use of labels to update the PR/issue status
- Mark your PRs as `work-in-progress` if it's still being worked on.
- Once you have solved the related issue, mark your PR with `need testing` and `need review` labels.
- When you’re making a PR with lots of code changes that affects multiple functionalities, or is likely to break, make sure you tag it with `Major Code Change` label.
## 📖 Documentations
- [Swagger API Documentation](https://ayushma-api.ohc.network)
## 💎 Backend
Ayushma's backend is built on Django. You can find documentation on the [Backend Repository](https://github.com/ohcnetwork/ayushma)
## 🚀 Production
#### Build the app for production
```sh
pnpm build
```
Builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance.
#### Start a production `http-server`
```sh
pnpm start
```
Starts a production http-server in local to run the project with Service worker.
The build is minified and the filenames include the hashes.
**🚀 Your app is ready to be deployed!**
## White Labeling
Ayushma is a white label product. You can customize the app to your needs by changing the following files:
### Images
| Path | Description |
| ----------------------- | -------------------- |
| `public/logo_text.svg` | Logo with text |
| `public/logo_white.svg` | Logo with white text |
| `public/logo.svg` | Logo without text |
### Environment Variables (place in `.env` / `.env.local` file)
| Variable | Description | Default |
| --------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `NEXT_PUBLIC_API_URL` | Backend API URL | `https://ayushma-api.ohc.network/api/` |
| `NEXT_PUBLIC_LOCAL_STORAGE` | Local storage key name | `ayushma-storage` |
| `NEXT_PUBLIC_AI_NAME` | Name of the AI | Ayushma |
| `NEXT_PUBLIC_AI_DESCRIPTION` | Description of the AI | Revolutionizing medical diagnosis through AI and Opensource |
| `NEXT_PUBLIC_AI_WARNING` | Warning message for accuracy | Please be aware that Ayushma AI may generate inaccurate information; kindly report any concerns to support@ohc.network |
| `NEXT_PUBLIC_GOOGLE_RECAPTCHA_SITE_KEY` | Google Recaptcha Site Key | `6Lerts4nAAAAAKyXaNZkYj4XfRO0M2R-XYIA3qv8` |