Skip to content

Commit

Permalink
add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rishi-raj-jain committed Nov 29, 2024
1 parent 3efb93d commit eec204f
Show file tree
Hide file tree
Showing 45 changed files with 169 additions and 68 deletions.
2 changes: 1 addition & 1 deletion ai/aws-bedrock/chatbot-nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

## AI Chatbot (AWS Bedrock)

Expand Down
2 changes: 1 addition & 1 deletion deploy-with-cloudflare-pages/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Cloudflare Pages

Expand Down
2 changes: 1 addition & 1 deletion deploy-with-cloudflare-workers/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Cloudflare Workers

Expand Down
2 changes: 1 addition & 1 deletion deploy-with-deno/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Deno

Expand Down
2 changes: 1 addition & 1 deletion deploy-with-heroku/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Heroku

Expand Down
2 changes: 1 addition & 1 deletion deploy-with-netlify-functions/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Netlify functions

Expand Down
2 changes: 1 addition & 1 deletion deploy-with-railway/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Railway

Expand Down
2 changes: 1 addition & 1 deletion deploy-with-render/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Render

Expand Down
2 changes: 1 addition & 1 deletion with-analog/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Analog

Expand Down
2 changes: 1 addition & 1 deletion with-angular/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Angular

Expand Down
2 changes: 1 addition & 1 deletion with-astro-api-routes/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Astro API Routes

Expand Down
2 changes: 1 addition & 1 deletion with-astro/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Astro

Expand Down
2 changes: 1 addition & 1 deletion with-dart/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Dart

Expand Down
2 changes: 1 addition & 1 deletion with-django/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Django

Expand Down
2 changes: 1 addition & 1 deletion with-express/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Express

Expand Down
2 changes: 1 addition & 1 deletion with-fastapi/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and FastAPI

Expand Down
2 changes: 1 addition & 1 deletion with-flask/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Flask

Expand Down
2 changes: 1 addition & 1 deletion with-golang-gorm/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Golang (Gorm ORM)

Expand Down
2 changes: 1 addition & 1 deletion with-golang/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Golang

Expand Down
2 changes: 1 addition & 1 deletion with-hono/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Hono

Expand Down
2 changes: 1 addition & 1 deletion with-nestjs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and NestJS

Expand Down
2 changes: 1 addition & 1 deletion with-nextjs-aws-s3/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon, Next.js and AWS S3

Expand Down
43 changes: 43 additions & 0 deletions with-nextjs-drizzle-edge/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon, Next.js, Drizzle and Vercel Edge

## Clone the repository

```bash
npx degit neondatabase/examples/with-nextjs-drizzle-edge ./with-nextjs-drizzle-edge
```

Run the command below to copy the `.env.example` file:

```
cp .env.example .env
```

## Store your Neon credentials

Store your Neon credentials in your `.env` file.

```
POSTGRES_URL="postgresql://neondb_owner:[email protected]/neondb?sslmode=require"
```

- `user` is the database user.
- `password` is the database user’s password.
- `endpoint_hostname` is the host with neon.tech as the [TLD](https://www.cloudflare.com/en-gb/learning/dns/top-level-domain/).
- `dbname` is the name of the database. “neondb” is the default database created with each Neon project.
- `?sslmode=require` an optional query parameter that enforces the [SSL](https://www.cloudflare.com/en-gb/learning/ssl/what-is-ssl/) mode while connecting to the Postgres instance for better security.

**Important**: To ensure the security of your data, never expose your Neon credentials to the browser.

Run the command below to install project dependencies:

```
npm install
```

Run the Next.js application using the following command:

```
npm run dev
```
2 changes: 1 addition & 1 deletion with-nextjs-edge-functions/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Next.js Edge Functions

Expand Down
2 changes: 1 addition & 1 deletion with-nextjs-get-server-side-props/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Next.js getServerSideProps

Expand Down
2 changes: 1 addition & 1 deletion with-nextjs-get-static-props/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Next.js getStaticProps

Expand Down
50 changes: 50 additions & 0 deletions with-nextjs-prisma-edge/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon, Next.js, Prisma and Vercel Edge

## Clone the repository

```bash
npx degit neondatabase/examples/with-nextjs-prisma-edge ./with-nextjs-prisma-edge
```

Run the command below to copy the `.env.example` file:

```
cp .env.example .env
```

## Store your Neon credentials

Store your Neon credentials in your `.env` file.

```
POSTGRES_PRISMA_URL="postgresql://neondb_owner:[email protected]/neondb?sslmode=require"
POSTGRES_URL_NON_POOLING="postgresql://neondb_owner:[email protected]/neondb?sslmode=require"
```

- `user` is the database user.
- `password` is the database user’s password.
- `endpoint_hostname` is the host with neon.tech as the [TLD](https://www.cloudflare.com/en-gb/learning/dns/top-level-domain/).
- `dbname` is the name of the database. “neondb” is the default database created with each Neon project.
- `?sslmode=require` an optional query parameter that enforces the [SSL](https://www.cloudflare.com/en-gb/learning/ssl/what-is-ssl/) mode while connecting to the Postgres instance for better security.

**Important**: To ensure the security of your data, never expose your Neon credentials to the browser.

Run the command below to install project dependencies:

```
npm install
```

Next, run the command below to seed the database:

```
npm run prisma:initiate
```

Finally, run the Next.js application using the following command:

```
npm run dev
```
55 changes: 32 additions & 23 deletions with-nextjs-prisma/README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,49 @@
# Neon with Next.js and Prisma
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

This app is built using the following technologies:
- Neon as the Postgres database
- Next.js as the fullstack framework
- Prisma as the ORM
# Getting started with Neon, Next.js and Prisma

First, clone the project locally and install the project dependencies by running the following commands:
## Clone the repository

```bash
git clone
cd with-nextjs-prisma
npm install
npx degit neondatabase/examples/with-nextjs-prisma ./with-nextjs-prisma
```

Run the command below to copy the `.env.example` file:

Next, update the .env file with your database credentials.
```
cp .env.example .env
```

## Store your Neon credentials

```bash
npm run setup
```
Store your Neon credentials in your `.env` file.

Next, run the following command to setup your project:

```bash
npm run setup
```
DATABASE_URL="postgresql://neondb_owner:[email protected]/neondb?sslmode=require"
```

This commands creates an initial migration and seeds the database with some initial data.
- `user` is the database user.
- `password` is the database user’s password.
- `endpoint_hostname` is the host with neon.tech as the [TLD](https://www.cloudflare.com/en-gb/learning/dns/top-level-domain/).
- `dbname` is the name of the database. “neondb” is the default database created with each Neon project.
- `?sslmode=require` an optional query parameter that enforces the [SSL](https://www.cloudflare.com/en-gb/learning/ssl/what-is-ssl/) mode while connecting to the Postgres instance for better security.

Finally, run the following command to start the development server:
**Important**: To ensure the security of your data, never expose your Neon credentials to the browser.

```bash
npm run dev
Run the command below to install project dependencies:

```
npm install
```

When you navigate to [http://localhost:3000](http://localhost:3000) you should see the following:
Next, run the command below to seed the database:

<img width="1920" alt="Arc-001513" src="https://user-images.githubusercontent.com/27310414/221444176-3e3c8d24-a2f8-40e5-bb81-313b03d22606.png">
```
npm run setup
```

Finally, run the Next.js application using the following command:

```
npm run dev
```
7 changes: 3 additions & 4 deletions with-nextjs-prisma/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint",
"setup": "npx prisma migrate dev -n initial-setup && npx prisma db seed"
},
"prisma": {
"seed": "ts-node --transpile-only --compiler-options {\"module\":\"CommonJS\"} prisma/seed.ts"
},
"dependencies": {
"@prisma/client": "4.10.1",
"next": "13.2.1",
Expand All @@ -25,8 +27,5 @@
"tailwindcss": "^3.2.7",
"ts-node": "10.9.1",
"typescript": "4.9.5"
},
"prisma": {
"seed": "ts-node --transpile-only --compiler-options {\"module\":\"CommonJS\"} prisma/seed.ts"
}
}
2 changes: 1 addition & 1 deletion with-nextjs-server-actions/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Next.js Server Actions

Expand Down
2 changes: 1 addition & 1 deletion with-nextjs-server-components/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Next.js Server Components

Expand Down
2 changes: 1 addition & 1 deletion with-nextjs-serverless-functions/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Next.js Serverless Functions

Expand Down
2 changes: 1 addition & 1 deletion with-nodejs-pg-notify/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Using pg_notify with Neon and NodeJS

Expand Down
2 changes: 1 addition & 1 deletion with-nodejs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and NodeJS

Expand Down
2 changes: 1 addition & 1 deletion with-python-asyncpg/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Python using asyncpg

Expand Down
2 changes: 1 addition & 1 deletion with-python-psycopg2/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Python using psycopg2

Expand Down
2 changes: 1 addition & 1 deletion with-remix/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Remix

Expand Down
2 changes: 1 addition & 1 deletion with-ruby/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Ruby

Expand Down
2 changes: 1 addition & 1 deletion with-rust/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img width="250px" src="https://raw.githubusercontent.com/neondatabase/website/a898a3ff9c2786a3fd4691d083eb8f3c751e008b/src/images/logo-white.svg" />
<img width="250px" src="https://neon.tech/brand/neon-logo-dark-color.svg" />

# Getting started with Neon and Rust

Expand Down
Loading

0 comments on commit eec204f

Please sign in to comment.