repository info 📜
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -35,7 +35,9 @@ yarn-error.log*
|
||||
*.tsbuildinfo
|
||||
next-env.d.ts
|
||||
|
||||
workbox-*.js.map
|
||||
workbox-*.js
|
||||
sw.js.map
|
||||
sw.js
|
||||
|
||||
.vercel
|
||||
|
||||
29
LICENSE
Normal file
29
LICENSE
Normal file
@@ -0,0 +1,29 @@
|
||||
BSD 3-Clause License
|
||||
|
||||
Copyright (c) 2022, Gustavo "Guz" L. de Mello
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
42
README.md
42
README.md
@@ -1,27 +1,35 @@
|
||||
# Next.js + Tailwind CSS Example
|
||||
# Hello.Kei
|
||||
|
||||
This example shows how to use [Tailwind CSS](https://tailwindcss.com/) [(v3.0)](https://tailwindcss.com/blog/tailwindcss-v3) with Next.js. It follows the steps outlined in the official [Tailwind docs](https://tailwindcss.com/docs/guides/nextjs).
|
||||
> This is a personal project made for testing, experimentation, _and a gift to
|
||||
> someone_ :black_heart:.
|
||||
|
||||
## Deploy your own
|
||||
## About
|
||||
|
||||
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-tailwindcss)
|
||||
A small Progressive Web Application (PWA) made for experimenting and learning
|
||||
concepts like User Interface (UI) and User Experience (UX). \*Created as a personal
|
||||
side project in my free time, ~~don't expect a fully scalable application or
|
||||
commits conventions in general~~.
|
||||
|
||||
[](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-tailwindcss&project-name=with-tailwindcss&repository-name=with-tailwindcss)
|
||||
Most of the application's content is private, so in this repository, there is just
|
||||
the source code for handling the interface.
|
||||
|
||||
## How to use
|
||||
## Main Stack
|
||||
|
||||
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
|
||||
- Framework: [Next.js](https://nextjs.org) ([React](https://reactjs.org))
|
||||
- Database: [Supabase](https://supabase.io)
|
||||
- Interface:
|
||||
- Components: [Mantine](https://mantine.dev)
|
||||
- Styling/Composing: [WindiCSS](https://windicss.org)
|
||||
- Icons: [Tabler](https://tabler-icons.io)
|
||||
- Custom Animations: [Framer Motion](https://framer.com/motion/)
|
||||
- Hosting: [Vercel](https://vercel.com)
|
||||
|
||||
```bash
|
||||
npx create-next-app --example with-tailwindcss with-tailwindcss-app
|
||||
```
|
||||
> This stack is chosen with the idea of trying to create a working application as
|
||||
> _fast and easy as possible_. And personal choice.
|
||||
|
||||
```bash
|
||||
yarn create next-app --example with-tailwindcss with-tailwindcss-app
|
||||
```
|
||||
---
|
||||
|
||||
```bash
|
||||
pnpm create next-app --example with-tailwindcss with-tailwindcss-app
|
||||
```
|
||||
### License
|
||||
|
||||
Licensed under the BSD 3-Clause License. See [LICENSE](LICENSE) for details.
|
||||
|
||||
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|
||||
|
||||
Reference in New Issue
Block a user