Skip to content

Commit

Permalink
template: set up a "default" template that future examples can build …
Browse files Browse the repository at this point in the history
…from (#2)

* initial commit

* add base clerk integration

* check point

* rename base tpl

* move again

* uncheck cache

* checkin examples dir

* base tpl readme cleanup

* add example env file

* add very basic readme instrucitons

* remove superflous files. keep public dir

* clean up env set up instructions

* rename base to default to match create-next-app

* make default layout be dashboard-style
  • Loading branch information
kylemac authored Jul 31, 2024
1 parent 4537373 commit 4b6eba4
Show file tree
Hide file tree
Showing 21 changed files with 5,638 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# orgs

a set of examples using [clerk's](https://clerk.com) orgs functionality

### to create a new example

```
cp -r templates/default examples/my-new-example
```
Empty file added examples/.gitkeep
Empty file.
2 changes: 2 additions & 0 deletions templates/default/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=abc
CLERK_SECRET_KEY=xyz
3 changes: 3 additions & 0 deletions templates/default/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "next/core-web-vitals"
}
36 changes: 36 additions & 0 deletions templates/default/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
27 changes: 27 additions & 0 deletions templates/default/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# templates: default

This is a base template to bootstrap a new orgs example

## Set Up

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

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
17 changes: 17 additions & 0 deletions templates/default/components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "default",
"rsc": true,
"tsx": true,
"tailwind": {
"config": "tailwind.config.ts",
"css": "src/app/globals.css",
"baseColor": "slate",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils"
}
}
4 changes: 4 additions & 0 deletions templates/default/next.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/** @type {import('next').NextConfig} */
const nextConfig = {};

export default nextConfig;
Loading

0 comments on commit 4b6eba4

Please sign in to comment.