Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whosramoss/coffee-boilerplate
Coffee Boilerplate is a time-saving Next.js and TypeScript boilerplate designed to accelerate your development process. Build interactive and engaging web experiences with ease.
https://github.com/whosramoss/coffee-boilerplate
eslint framer-motion next-theme nextjs tailwindcss typescript zod
Last synced: 16 days ago
JSON representation
Coffee Boilerplate is a time-saving Next.js and TypeScript boilerplate designed to accelerate your development process. Build interactive and engaging web experiences with ease.
- Host: GitHub
- URL: https://github.com/whosramoss/coffee-boilerplate
- Owner: whosramoss
- License: mit
- Created: 2024-05-30T13:04:14.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-21T20:02:23.000Z (4 months ago)
- Last Synced: 2024-10-18T05:09:28.983Z (21 days ago)
- Topics: eslint, framer-motion, next-theme, nextjs, tailwindcss, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 49.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
This template provides a starting point for building Next.js apps with amazing animations.
Check the preview
## How to install ⚡
```bash
# Clone the project
git clone https://github.com/whosramoss/coffee-boilerplate/
# Go to the project directory
cd coffee-boilerplate
# Install dependencies
npm install
# Start the server
npm run dev
```
## How to build ⚡
- To generate a static compilation, the `next.config.mjs` file must have the parameters below :
```bash
const staticbuild = {
distDir: 'build',
output: 'export',
trailingSlash: true,
}
```
- Run the command:
```bash
npm run build
```
## Structure 📂
- [src](./src/) – Add all folders below
- [app](./src/app/) – Contains pages, layouts, and api routes
- [client](./src/client/) – Contains components, hooks, providers, and styles
- [server](./src/server/) – Contains schemas and services
- [shared](./src/shared/) – Contains methods, types, enums and constants that will be used in more than one place in the application
## Features 🦾
- [Next.js](https://nextjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Prettier](https://prettier.io/)
- [ESLint](https://eslint.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Framer Motion](https://framer.com/motion)
- [Zod](https://zod.dev/)
## Hooks ⚡
### Animation
- [useAnimationCursor](./src/client/hooks/useAnimationCursor.ts)
- [useAnimationFadeIn](./src/client/hooks/useAnimationFadeIn.ts)
- [useAnimationHoriozontalList](./src/client/hooks/useAnimationHoriozontalList.ts)
- [useAnimationHover](./src/client/hooks/useAnimationHover.ts)
- [useAnimationItemMouseMove](./src/client/hooks/useAnimationItemMouseMove.ts)
- [useAnimationParallax](./src/client/hooks/useAnimationParallax.ts)
- [useAnimationParallaxImage](./src/client/hooks/useAnimationParallaxImage.ts)
- [useAnimationSplash](./src/client/hooks/useAnimationSplash.ts)
- [useAnimationTextScroll](./src/client/hooks/useAnimationTextScroll.ts)
### Others
- [useApiFetch](./src/client/hooks/useApiFetch.ts)
- [useLocalStorage](./src/client/hooks/useLocalStorage.ts)
- [useMediaQuery](./src/client/hooks/useMediaQuery.ts)
- [useTabs](./src/client/hooks/useTabs.ts)
- [useTimeout](./src/client/hooks/useTimeout.ts)
## API
[FAKE COFFEE API](https://fake-coffee-api.vercel.app/) : Fake coffee products rest API for your e-commerce or cafe website prototype
## Contributing 📄
If you want to contribute to `coffee-boilerplate`, please make sure to review the [contribution guidelines](https://github.com/whosramoss/coffee-boilerplate/blob/master/CONTRIBUTING.md). This project makes use of [GitHub issues](https://github.com/whosramoss/coffee-boilerplate/issues) for
tracking requests and bugs.
## License 📄
MIT License. [LICENSE](./LICENSE)
## Author ✍️
Gabriel Ramos ([@whosramoss](https://github.com/whosramoss))
