From 555cde26028fa942b7e62cec3add3e34b5758aaa Mon Sep 17 00:00:00 2001
From: Waleed Ishfaq <110061477+waleedcodes@users.noreply.github.com>
Date: Mon, 15 Jul 2024 17:56:44 +0500
Subject: [PATCH] Update Readme

Update the readme with instructions on how to get started with this repository and how to contribute to it.o contribute to it.
---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 60 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5ba35f198..0dd5d050a 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
 
 This repository provides a starter template for creating applications using Next.js (App Router) and AWS Amplify, emphasizing easy setup for authentication, API, and database capabilities.
 
+Learn more: [AWS Amplify Quickstart](https://docs.amplify.aws/gen2/start/quickstart/ )
+
 ## Overview
 
 This template equips you with a foundational Next.js application integrated with AWS Amplify, streamlined for scalability and performance. It is ideal for developers looking to jumpstart their project with pre-configured AWS services like Cognito, AppSync, and DynamoDB.
@@ -12,14 +14,71 @@ This template equips you with a foundational Next.js application integrated with
 - **API**: Ready-to-use GraphQL endpoint with AWS AppSync.
 - **Database**: Real-time database powered by Amazon DynamoDB.
 
+
+## Getting Started
+
+### `Prerequisites`
+
+Before you begin, ensure you have the following installed:
+
+- Node.js
+- npm, yarn, pnpm, or bun (package managers)
+- AWS CLI (for AWS Amplify setup)
+
+## Installation
+
+#### `Clone the repository:`
+
+```
+git clone https://github.com/your-repo/aws-amplify-nextjs-starter.git
+cd aws-amplify-nextjs-starter
+```
+
+#### `Install dependencies:`
+
+```
+npm install
+#or
+yarn install
+#or
+pnpm install
+#or
+bun install
+```
+
+#### `Running the Development Server`
+
+Start the development server:
+
+```
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open http://localhost:3000 with your browser to see the result.
+
+
 ## Deploying to AWS
 
 For detailed instructions on deploying your application, refer to the [deployment section](https://docs.amplify.aws/nextjs/start/quickstart/nextjs-app-router-client-components/#deploy-a-fullstack-app-to-aws) of our documentation.
 
+
 ## Security
 
 See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
 
+
+## Contributing
+
+Contributions are welcome! Please read the [AWS Amplify
+Contributor Program](https://docs.amplify.aws/contribute/) guidelines before contributing.
+
+
 ## License
 
-This library is licensed under the MIT-0 License. See the LICENSE file.
\ No newline at end of file
+This library is licensed under the MIT-0 License. See the LICENSE file.