-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs repo instructions (#192)
- Loading branch information
Showing
3 changed files
with
13 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters