Skip to content

Commit

Permalink
Update docs repo instructions (#192)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kitenite authored Aug 21, 2024
1 parent 1470994 commit 297c127
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 54 deletions.
56 changes: 7 additions & 49 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,16 @@
# Next Entree
# Onlook Docs
The documentation repo for Onlook. Part of the monorepo for now but may one day split off into its own repo.

Next.js 14+ starter template with app router, shadcn/ui, typesafe env, icons and configs setup.
# How to run

## Usage

1. Setup a project using the template

```bash
pnpm create next-app -e https://github.com/redpangilinan/next-entree
```

```bash
npx create-next-app -e https://github.com/redpangilinan/next-entree
```

```bash
yarn create next-app -e https://github.com/redpangilinan/next-entree
```
1. Install depenedencies

```bash
bunx create-next-app -e https://github.com/redpangilinan/next-entree
npm i
```

2. Copy `.env.example` to `.env.local`
2. Run the app

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

## Features

This template uses [shadcn](https://github.com/shadcn)'s Next.js app structure from [shadcn/ui](https://ui.shadcn.com/).

- Next.js 14+ `/app` router
- TypeScript
- Tailwind CSS
- shadcn/ui (Radix UI + Tailwind)
- Prettier (w/ auto sort imports and tailwind classes)
- SEO optimized
- Typesafe env, icons, and config
- Ready to use - jump right into development

## Scripts

If you are using a different package manager, be sure to update the package.json format scripts.

1. Check project formatting

```bash
pnpm format:check
```

2. Format the project

```bash
pnpm format
npm run dev
```
4 changes: 2 additions & 2 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"build": "next build",
"start": "next start",
"lint": "next lint",
"format": "pnpm prettier ./src --write",
"format:check": "pnpm prettier ./src --check"
"format": "prettier ./src --write",
"format:check": "prettier ./src --check"
},
"dependencies": {
"@radix-ui/react-dropdown-menu": "^2.0.6",
Expand Down
7 changes: 4 additions & 3 deletions docs/src/config/site.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { SiteConfig } from "@/types"
import { env } from "@/env.mjs"

const NEXT_PUBLIC_APP_URL = 'http://localhost:3000'

export const siteConfig: SiteConfig = {
name: "Onlook Docs",
Expand All @@ -8,11 +9,11 @@ export const siteConfig: SiteConfig = {
"The documentation for the first developer tool for designers",
keywords: ["onlook", "documentation", "designer", "developer"],
url: {
base: env.NEXT_PUBLIC_APP_URL,
base: NEXT_PUBLIC_APP_URL,
author: "https://onlook.dev",
},
links: {
quickstart: "/quickstart",
},
ogImage: `${env.NEXT_PUBLIC_APP_URL}/og.jpg`,
ogImage: `${NEXT_PUBLIC_APP_URL}/og.jpg`,
}

0 comments on commit 297c127

Please sign in to comment.