Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme #51

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Readme #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 60 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
This library is licensed under the MIT-0 License. See the LICENSE file.