windmill-dashboard-nextjs-typescript - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #go #android #machine-learning #docker #nodejs #kubernetes #vue #awesome-list #ios #open-source

windmill-dashboard-nextjs-typescript

(★ 264)

Nextjs Admin Dashboard UI

파일 탐색기

최종 버전 다운로드 (.zip)

- windmill-dashboard-thumbnail.jpg
- settings.json
- SidebarContext.tsx
- ThemeContext.tsx
- - AccessibleNavigationAnnouncer.tsx
  - CTA.tsx
  - Header.tsx
  - RoundIcon.tsx
  - ThemedSuspense.tsx
- - Layout.tsx
  - Main.tsx
- bell.svg
- buttons.svg
- cards.svg
- cart.svg
- charts.svg
- chat.svg
- dropdown.svg
- edit.svg
- forbidden.svg
- forms.svg
- github.svg
- heart.svg
- home.svg
- index.ts
- mail.svg
- menu.svg
- modals.svg
- money.svg
- moon.svg
- outlineCog.svg
- outlineLogout.svg
- outlinePerson.svg
- pages.svg
- people.svg
- search.svg
- sun.svg
- tables.svg
- trash.svg
- twitter.svg
- - hello.ts
- - 404.tsx
  - blank.tsx
  - buttons.tsx
  - cards.tsx
  - charts.tsx
  - create-account.tsx
  - forgot-password.tsx
  - forms.tsx
  - index.tsx
  - login.tsx
  - modals.tsx
  - tables.tsx
- _app.tsx
- index.tsx
- favicon.ico
- vercel.svg
- sidebar.tsx
- globals.css
- Home.module.css
- - chartsData.ts
  - tableData.ts
.eslintrc.json
.gitignore
LICENSE
next-env.d.ts
next.config.js
package.json
postcss.config.js
README.md
tailwind.config.js
tsconfig.json
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/roketid/windmill-dashboard-nextjs-typescript

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd windmill-dashboard-nextjs-typescript

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

yarn install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm run dev

개발/실행 서버를 켭니다.

yarn dev

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
    <h1>Windmill Dashboard Next.js Typescript</h1>
    <a href="https://windmill-dashboard-nextjs-typescript.vercel.app/example">
      <img alt="Windmill Dashboard React" width="600" src=".github/windmill-dashboard-thumbnail.jpg">
    </a><br>
</p>

See the [Original Project by @estevanmaito](https://github.com/estevanmaito/windmill-dashboard-react/)

With help from other contributors :
- [Typescript version by @neutralboy](https://github.com/neutralboy/windmill-dashboard-react-ts)
- [Nextjs version by @Aldhanekaa](https://github.com/Aldhanekaa/windmill-dashboard-nextjs)

🚀 [See it live](https://windmill-dashboard-nextjs-typescript.vercel.app/example)

This is not a template. This is a complete application, built on top of React, with all tiny details taken care of so you just need to bring the data to feed it.

Accessibility is a priority in my projects and I think it should be in yours too, so this was developed listening to real screen readers, focus traps and keyboard navigation are available everywhere.

## 📦 Features

- 🦮 Throughly accessible (developed using screen readers)
- 🌗 Dark theme enabled (load even different images based on theme)
- 🧩 Multiple (custom) components
- ⚡ Code splitting
- Tailwind CSS
- [Windmill React UI](https://windmillui.com/react-ui)
- Heroicons
- Chart.js

## 📚 Docs

### General components

Windmill Dashboard React is built on top of [Windmill React UI](https://windmillui.com/react-ui). You will find the documentation for every small component there.

### Example Boilerplate

All components and containers are saved in folder [example](example)

### Routing

Change default redirecting when hit the `/` or `home` in file [next.config.js](next.config.js)
```js
  async redirects() {
    return [
      {
        source: '/',
        destination: '/example/login',
        permanent: false,
      },
    ]
  }
```

#### Sidebar routes

To configure sidebar menus, see file ([routes/sidebar.tsx](routes/sidebar.tsx)).

These are the routes that will show in the sidebar. They expect three properties:

- `path`: the destination;
- `name`: the name to be shown;
- `icon`: an icon to illustrate the item

Item that are used as dropdowns, like the Pages option, don't need a `path`, but expect a `routes` array of objects with `path` and `name`:

```js
// sidebar.js
{
  path: '/example/tables',
  icon: 'TablesIcon',
  name: 'Tables',
},
{
  icon: 'PagesIcon', // <-- this is used as a submenu, so no path
  name: 'Pages',
  routes: [
    // submenu
    {
      path: '/example/login',
      name: 'Login', // <-- these don't have icons
    },
    {
      path: '/example/create-account',
      name: 'Create account',
    },
```

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, install dependencies :
```bash
npm install
# or
yarn install
```

then, you can run the development server:

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

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

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

## 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.