Skip to content

Commit cea25ec

Browse files
Update README.md
1 parent 46081d2 commit cea25ec

File tree

1 file changed

+86
-21
lines changed

1 file changed

+86
-21
lines changed

README.md

Lines changed: 86 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,102 @@
1-
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).
1+
<a href="https://next-flowbite-react.vercel.app/" target="_blank"><img src="https://raw.githubusercontent.com/sagarmusabbir/next-flowbite-react/main/public/screenshot.png" href="https://next-flowbite-react.vercel.app/"/></a>
2+
3+
<img src="https://img.shields.io/github/package-json/v/sagarmusabbir/next-flowbite-react?label=package.json&labelColor=%2364748b
4+
"/>
5+
6+
7+
8+
9+
## Deploy
10+
11+
The easiest way to deploy your Nextjs Flowbite-React 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 their [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
12+
13+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fhello-world)
14+
15+
Similarly you can deploy to [Netlify](https://netlify.com) with their one click deployment button from here. You can browse their [site deploy documentation](https://nextjs.org/docs/deployment)
16+
17+
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify/netlify-statuskit)
18+
19+
20+
21+
### Built With
22+
23+
<p float="left">
24+
<img src="https://img.shields.io/badge/_-Next-%23334155?style=for-the-badge&logo=next.js"/>
25+
<img src="https://img.shields.io/badge/_-Tailwind-%23334155?style=for-the-badge&logo=tailwindcss"/>
26+
<img src="https://img.shields.io/badge/_-Node-%23334155?style=for-the-badge&logo=node.js"/>
27+
<img src="https://img.shields.io/badge/_-Javascript-%23334155?style=for-the-badge&logo=javascript"/>
28+
<img src="https://img.shields.io/badge/_-React-%23334155?style=for-the-badge&logo=react"/>
29+
<img src="https://img.shields.io/badge/_-Vercel-%23334155?style=for-the-badge&logo=vercel"/>
30+
<img src="https://img.shields.io/badge/_-Wordpress-%23334155?style=for-the-badge&logo=wordpress"/>
31+
32+
</p>
33+
34+
## Description
35+
36+
A Boilerplate for NextJs + FlowbiteReact - This is an open source boilerplate made by [Third Bracket](https://www.thirdbracket.co.uk/) which anyone can use without any credit.
237

338
## Getting Started
439

5-
First, run the development server:
40+
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).
41+
42+
```
43+
npm create next app
44+
```
45+
46+
### Depedencies
647

748
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
49+
"flowbite": "^2.3.0",
50+
"flowbite-react": "^0.7.0-beta.6",
51+
"next": "^14.1.3",
52+
"react": "^18",
53+
"react-dom": "^18"
54+
```
55+
56+
### Installing
57+
58+
1. Clone the repo and enter the directory
59+
60+
```sh
61+
git clone https://github.com/sagarmusabbir/FlowbiteReact-NextJs-Boilerplate.git
62+
cd FlowbiteReact-NextJs-Boilerplate
1563
```
1664

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
65+
2. Install NPM packages
66+
67+
```sh
68+
npm install or yarn install
69+
```
70+
71+
3. Run project
72+
73+
```sh
74+
npm run dev or yarn dev
75+
```
76+
77+
## Contact
78+
79+
sagarmusabbir@gmail.com
80+
81+
Project Link: [FlowbiteReact-NextJs-Boilerplate](https://github.com/sagarmusabbir/FlowbiteReact-NextJs-Boilerplate)
1882

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
83+
## Authors
2084

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
85+
1. Musabbir Sagar [@myLinkedIn](https://www.linkedin.com/in/musabbirsagar/)
2286

23-
## Learn More
87+
## Version History
2488

25-
To learn more about Next.js, take a look at the following resources:
89+
- 0.1
90+
- Initial Release
2691

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
92+
<!-- ## License
2993
30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
94+
This project is licensed under the [Name] License - see the LICENSE.md file for details -->
3195

32-
## Deploy on Vercel
96+
## Acknowledgements
3397

34-
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.
98+
- [TailwindCss](https://www.tailwindcss.com)
99+
- [Next Documentation](https://nextjs.org/docs)
100+
- [Flowbite React Documentation](https://www.flowbite-react.com/docs/getting-started/introduction)
101+
- [Flowbite Documentation](https://flowbite.com/docs/getting-started/introduction/)
35102

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
37-
# next-flowbite-react

0 commit comments

Comments
 (0)