Skip to content

Commit

Permalink
feat(docs): add landing page (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexfertel authored Aug 29, 2024
1 parent 8c8e573 commit 7ec05c5
Show file tree
Hide file tree
Showing 16 changed files with 4,012 additions and 1 deletion.
36 changes: 35 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,38 @@ target/
*~
\#*\#

.DS_Store
**/.DS_Store

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

# testing
docs/coverage

# next.js
docs/.next/
docs/out/

# production
docs/build

# misc
*.pem

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

# local env files
docs/.env*.local

# vercel
docs/.vercel

# typescript
docs/*.tsbuildinfo
docs/next-env.d.ts
3 changes: 3 additions & 0 deletions docs/.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 docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
This directory holds the `bulloak` documentation site.

## 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 `src/app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
4 changes: 4 additions & 0 deletions docs/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;
28 changes: 28 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"name": "docs",
"version": "0.1.0",
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint"
},
"dependencies": {
"@vercel/analytics": "^1.1.2",
"@vercel/speed-insights": "^1.0.8",
"react": "^18",
"react-dom": "^18",
"next": "14.2.6"
},
"devDependencies": {
"typescript": "^5",
"@types/node": "^20",
"@types/react": "^18",
"@types/react-dom": "^18",
"postcss": "^8",
"tailwindcss": "^3.4.1",
"eslint": "^8",
"eslint-config-next": "14.2.6"
}
}
Loading

0 comments on commit 7ec05c5

Please sign in to comment.