Merge pull request #56 from tsd2024/develop

feat: update readme

.template.env

@@ -0,0 +1,9 @@
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_SECRET=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+BACKEND_URL=
+WEBSOCKET_PROTOCOL=
+BACKEND_PROTOCOL=

README.md

@@ -1,8 +1,22 @@
-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).
+# Planning poker - frontend
+
+
+## Team Members
+
+
+| Name              | University ID       |
+|-------------------|---------------------|
+| Julia Mularczyk     | 148062             |
+| Miłosz Matuszewski        | 148185             |
+| Jan Szczuka      | 148075             |
+| Jakub Mrówczyński     | 148068             |
+
+
 
 ## Getting Started
 
 First, run the development server:
+Node.js is required to start the application
 
 ```bash
 npm run dev
@@ -16,22 +30,10 @@ bun dev
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
+## How to deploy
 
-To learn more about Next.js, take a look at the following resources:
-
-- [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.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-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.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+To deploy frontend side of the application, one needs to specify all the environemnt variables that are stated in ci/cd pipeline file and run command below.
+```bash
+npx sst deploy --stage prod
+```