Merge branch 'main' of github.com:DIPSAS/hello-open-dips

README.md

@@ -1,36 +1,42 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Hello Open DIPS React App
 
-## Getting Started
+Thanks for checking out our Hello World SMART on FHIR app that connects to our
+DIPS sandbox, [Open DIPS](https://open.dips.no)! In short this application
+showcases how you can build a SMART on FHIR app that works with DIPS Arena.
+It's a patient-specific app which fetches some basic information about the
+patient, e.g. their date of birth and a list of documents in the EHR. 
 
-First, run the development server:
+![Screenshot of the app](public/screenshot.png)
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+# Try the app
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+If you'd only like to see how the app looks, go to
+[hello.open.dips.no](https://hello.open.dips.no). When asked for credentials you
+can use `OPENDIPS` as both username and password. You can see more information 
+about valid data to test with on [open.dips.no/data](https://open.dips.no/data) 
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+# Run the app yourself
 
-## Learn More
+To run this app yourself, 
 
-To learn more about Next.js, take a look at the following resources:
+1. Clone down the repository 
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+``` 
+$ git clone https://github ... 
+```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+2. Go to open.dips.no/profile and grab the subscription key to our APIs. The
+	 app needs the subscription key to be able to call our APIs. 
+3. Replace the subscription key in the `.env` file. 
+4. Build and run the app with `npm`. PS: You'll need to download and install [Node.js](https://nodejs.org/en/) first! 
 
-## Deploy on Vercel
+```
+$ npm install
+$ npm run build
+$ npm run start 
+``` 
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+# Questions? 
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+If you have any questions or issues [please submit a new Issue!](https://github.com/DIPSAS/hello-open-dips/issues/new/choose)
+If you want to contribute to the app, or have any changes, feel free to submit a pull request.