https://github.com/tofu1304/nextjs-sst-starter
Modern Next.js starter with serverless AWS infrastructure using SST. Features a contact form, TypeScript, Tailwind CSS, and automated deployments. 🚀🌐
https://github.com/tofu1304/nextjs-sst-starter
aws aws-ses github-workflows husky lint-staged nextjs prettier pulumi-aws sst
Last synced: 3 months ago
JSON representation
Modern Next.js starter with serverless AWS infrastructure using SST. Features a contact form, TypeScript, Tailwind CSS, and automated deployments. 🚀🌐
- Host: GitHub
- URL: https://github.com/tofu1304/nextjs-sst-starter
- Owner: Tofu1304
- Created: 2025-07-04T06:29:53.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-07-11T09:32:22.000Z (3 months ago)
- Last Synced: 2025-07-11T12:39:06.341Z (3 months ago)
- Topics: aws, aws-ses, github-workflows, husky, lint-staged, nextjs, prettier, pulumi-aws, sst
- Language: TypeScript
- Size: 133 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Next.js SST Starter: A Powerful Template for AWS Deployments 🚀
  
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Getting Started](#getting-started)
- [Project Structure](#project-structure)
- [Technologies Used](#technologies-used)
- [Deployment](#deployment)
- [GitHub Workflows](#github-workflows)
- [Linting and Formatting](#linting-and-formatting)
- [Contributing](#contributing)
- [License](#license)
- [Releases](#releases)
## Overview
Welcome to the **Next.js SST Starter**! This repository provides an opinionated starter template for building applications with Next.js and deploying them on AWS using SST (Serverless Stack). It simplifies the process of setting up your development environment and deploying your app with best practices in mind.
To get started, you can download the latest release [here](https://github.com/Tofu1304/nextjs-sst-starter/releases) and execute the necessary commands to set up your project.
## Features
- **Opinionated Structure**: Designed with best practices in mind.
- **Serverless Deployments**: Easily deploy your app on AWS.
- **Integrated with SST**: Use SST to manage your serverless resources.
- **Tailwind CSS**: Built-in support for styling your application.
- **Linting and Formatting**: Pre-configured with ESLint and Prettier.
- **GitHub Workflows**: CI/CD setup for automated testing and deployment.
## Getting Started
To set up your Next.js SST Starter project, follow these steps:
1. **Clone the Repository**:
```bash
git clone https://github.com/Tofu1304/nextjs-sst-starter.git
cd nextjs-sst-starter
```
2. **Install Dependencies**:
```bash
npm install
```
3. **Run the Development Server**:
```bash
npm run dev
```
Your application should now be running at `http://localhost:3000`.
## Project Structure
Here’s a brief overview of the project structure:
```
nextjs-sst-starter/
├── public/ # Static files
├── src/ # Application source code
│ ├── components/ # Reusable components
│ ├── pages/ # Next.js pages
│ ├── styles/ # Global styles
│ └── utils/ # Utility functions
├── .eslintrc.json # ESLint configuration
├── .prettierrc # Prettier configuration
├── sst.config.ts # SST configuration
└── package.json # Project metadata and dependencies
```
## Technologies Used
This project utilizes the following technologies:
- **Next.js**: A React framework for server-side rendering and static site generation.
- **SST**: A framework for building serverless applications on AWS.
- **Tailwind CSS**: A utility-first CSS framework for styling.
- **Pulumi**: Infrastructure as code tool for managing cloud resources.
- **GitHub Actions**: CI/CD automation for workflows.
## Deployment
To deploy your application to AWS, follow these steps:
1. **Set Up AWS Credentials**: Make sure you have your AWS credentials configured. You can do this by setting the environment variables or using the AWS CLI.
2. **Deploy with SST**:
```bash
npx sst deploy
```
3. **Check Your Deployment**: After the deployment completes, SST will provide you with a URL to access your application.
## GitHub Workflows
This repository comes with pre-configured GitHub workflows to automate testing and deployment. You can find the workflow files in the `.github/workflows` directory. These workflows will:
- Run tests on push and pull request events.
- Deploy the application on the main branch.
## Linting and Formatting
We use ESLint for linting and Prettier for formatting. You can run the following commands to lint and format your code:
- **Lint**:
```bash
npm run lint
```
- **Format**:
```bash
npm run format
```
You can also configure Husky and lint-staged to run these checks automatically before commits.
## Contributing
We welcome contributions! If you would like to contribute to this project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch to your fork.
5. Create a pull request.
Please ensure your code adheres to the existing style and passes all tests.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Releases
To download the latest release, visit the [Releases](https://github.com/Tofu1304/nextjs-sst-starter/releases) section. Here, you can find the latest versions and update your project accordingly.
For further information, check the "Releases" section if you encounter any issues or need specific versions.