Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brijr/index
Homepage of Bridger Tower on the Internet.
https://github.com/brijr/index
Last synced: about 1 month ago
JSON representation
Homepage of Bridger Tower on the Internet.
- Host: GitHub
- URL: https://github.com/brijr/index
- Owner: brijr
- License: mit
- Created: 2024-12-10T04:04:12.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T05:24:43.000Z (about 2 months ago)
- Last Synced: 2024-12-10T05:26:27.690Z (about 2 months ago)
- Language: TypeScript
- Size: 173 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 9d8/pay
A modern, full-stack starter template powered by PayloadCMS and Next.js. Built with performance and developer experience in mind.
[](https://vercel.com/new/git/external?repository-url=https://github.com/9d8dev/pay&project-name=pay&repository-name=pay&branch=main)
> Need a version with user auth? Check out [pay-auth](https://github.com/9d8dev/pay-auth)
## Features
- **Next.js 15** with App Router
- **PayloadCMS** for content management
- **PostgreSQL** database with Neon
- **AWS S3** for media storage
- **Tailwind CSS** & **shadcn/ui** for styling
- **Responsive** & **Mobile-First** design
- **TypeScript** for type safety
- **brijr/craft** utilities included
## Prerequisites
Before you begin, ensure you have:
- Node.js (^18.20.2 or >=20.9.0)
- pnpm package manager
- PostgreSQL database (local or cloud)
- AWS S3 bucket for media storage
- Basic knowledge of TypeScript and React
## Quick Start
1. Clone and install dependencies:
```bash
git clone https://github.com/9d8dev/pay.git
cd pay
pnpm install
```
2. Set up your environment:
```bash
cp .env.example .env
```
3. Configure your `.env` file with:
```env
# Database Configuration
DATABASE_URI=your_postgres_connection_string
PAYLOAD_SECRET=your_secure_secret_key
# S3 Configuration
S3_BUCKET=your_bucket_name
S3_REGION=your_bucket_region
S3_ACCESS_KEY_ID=your_access_key
S3_SECRET_ACCESS_KEY=your_secret_key
```
4. Start the development server:
```bash
pnpm dev
```
5. Visit http://localhost:3000/admin to create your first admin user
## Detailed Setup Guide
### Database Setup
1. **Local PostgreSQL:**
- Install PostgreSQL on your machine
- Create a new database
- Use the connection string: `postgresql://username:password@localhost:5432/database`
2. **Cloud PostgreSQL (Recommended):**
- Create a database on [Neon](https://neon.tech)
- Copy the connection string from your dashboard
- Enable SSL mode with `?sslmode=require`
### AWS S3 Configuration ([Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteAccessPermissionsReqd.html))
1. Create an S3 bucket:
- Go to AWS Console > S3
- Create a new bucket
- Enable public access settings
- Configure CORS for your domain
2. Create IAM credentials:
- Create a new IAM user
- Attach `AmazonS3FullAccess` policy
- Save the access key and secret
3. Configure bucket policy:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "PublicReadGetObject",
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::your-bucket-name/*"
}
]
}
```
## Development
### Project Structure
```
pay/
├── src/
│ ├── app/ # Next.js app router
│ ├── collections/ # PayloadCMS collections
│ ├── components/ # React components
│ └── lib/ # Utility functions
├── public/ # Static assets
└── package.json # Dependencies
```
### Key Commands
- `pnpm dev` - Start development server
- `pnpm build` - Build for production
- `pnpm start` - Start production server
- `pnpm generate:types` - Generate PayloadCMS types
## Deployment
### Vercel Deployment
1. Push your code to GitHub
2. Import project to Vercel
3. Configure environment variables
4. Deploy!
### Database Deployment
- Use PostgreSQL (We recommend [Neon](https://neon.tech), or any other cloud provider with PostgreSQL support)
- Enable serverless pooling
- Configure connection pooling
## Contributing
We welcome contributions! Please:
1. Fork the repository
2. Create a feature branch
3. Submit a pull request
## Support
- [PayloadCMS Documentation](https://payloadcms.com/docs)
- [Next.js Documentation](https://nextjs.org/docs)
- [Payload Discord Community](https://discord.gg/payload)
- [Issue Tracker](https://github.com/9d8dev/pay/issues)
## License
MIT [9d8](https://github.com/9d8dev)