Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngimdock/synes-dashbord
The original project is in the Talk organisation, this repository is just for deployment purposes.
https://github.com/ngimdock/synes-dashbord
Last synced: 1 day ago
JSON representation
The original project is in the Talk organisation, this repository is just for deployment purposes.
- Host: GitHub
- URL: https://github.com/ngimdock/synes-dashbord
- Owner: ngimdock
- License: mit
- Created: 2023-07-17T07:52:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-17T08:24:15.000Z (over 1 year ago)
- Last Synced: 2023-07-17T09:36:12.763Z (over 1 year ago)
- Language: TypeScript
- Size: 12.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Windmill Dashboard Next.js Typescript
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.