feature/app-37 Add Readme

feature/app-37 Add Readme

.env

@@ -1,9 +1,8 @@
-# Qwacker backend
-NEXT_PUBLIC_QWACKER_API_URL=https://qwacker-api-http-prod-4cxdci3drq-oa.a.run.app/
+NEXT_PUBLIC_QWACKER_API_URL=[insert URL of Qwacker API]
 
 # Authentication
 NEXTAUTH_URL=http://localhost:3000
-NEXTAUTH_SECRET=topsecret
+NEXTAUTH_SECRET=[insert nextauth secret]
 
-ZITADEL_ISSUER=https://cas-fee-advanced-ocvdad.zitadel.cloud
-ZITADEL_CLIENT_ID=181236603920908545@cas_fee_adv_qwacker_prod
+ZITADEL_ISSUER=[insert zitadel issuer URL]
+ZITADEL_CLIENT_ID=[insert zitadel client id]

README.md

@@ -1,34 +1,58 @@
-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).
+# Team Hello World - Frontend Engineering Advanced
 
-## Getting Started
-
-First, run the development server:
+## Deployed Application
+You find the deployed application here: https://app-helloworld-1.vercel.app/
 
+## Installation Guide
+### Clone this repo
 ```bash
-npm run dev
-# or
-yarn dev
+git clone https://github.com/smartive-education/app-helloworld.git
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+### Authenticating GitHub Registry
+
+To install the UI component library package you need a personal GitHub Access Token.
+
+- Create a GitHub [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
+- Create a new `.npmrc` file in the root of your repository
+- Add the key and the declaration of the owner to your project. Replace TOKEN with your access token.
+
+```console
+@smartive-education:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=TOKEN
+```
 
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+To find more detailed information see [Working with the npm registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry).
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+### Install the dependencies
+Then, install the dependencies:
+```bash
+npm ci
+```
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+### Create Environment Variables
+Insert te missing content into the .env file in the root.
+```console
+NEXT_PUBLIC_QWACKER_API_URL=[insert URL of Qwacker API]
 
-## Learn More
+# Authentication
+NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_SECRET=[insert nextauth secret]
 
-To learn more about Next.js, take a look at the following resources:
+ZITADEL_ISSUER=[insert zitadel issuer URL]
+ZITADEL_CLIENT_ID=[insert zitadel client id]
+```
 
-- [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.
+### Start the developement server
+Now, you can run the development server:
+```bash
+npm run dev
+```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-## Deploy on Vercel
+## Authors
 
-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.
+[Mehmet Ali Bekooglu](https://github.com/malib)
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+[Carole Hug](https://github.com/CaroleHug)