Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 4.73 KB

README.md

File metadata and controls

103 lines (72 loc) · 4.73 KB
Raw

Ayushma Logo

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

pnpm i

🏃 Run the app in development mode

pnpm dev

Once the development server has started, open 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

- email: [email protected]
  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

💎 Backend

Ayushma's backend is built on Django. You can find documentation on the Backend Repository

🚀 Production

Build the app for production

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

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 [email protected]
NEXT_PUBLIC_GOOGLE_RECAPTCHA_SITE_KEY Google Recaptcha Site Key 6Lerts4nAAAAAKyXaNZkYj4XfRO0M2R-XYIA3qv8