Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samuelgoddard/sam-goddard-2023
https://github.com/samuelgoddard/sam-goddard-2023
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/samuelgoddard/sam-goddard-2023
- Owner: samuelgoddard
- Created: 2023-06-16T11:50:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T20:58:34.000Z (8 months ago)
- Last Synced: 2024-04-18T20:42:44.912Z (7 months ago)
- Language: JavaScript
- Homepage: https://sam-goddard-2023.vercel.app
- Size: 31.7 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shiftwalk Starter
Demo: [https://sg-next-tailwind-motion.vercel.app/](https://sg-next-tailwind-motion.vercel.app/)
Locomotive Scroll Demo: [https://sg-next-tailwind-motion-locomotive.vercel.app/](https://sg-next-tailwind-motion-locomotive.vercel.app/)
A simple [Next.js](https://nextjs.org/) boilerplate with [TailwindCSS](https://tailwindcss.com/) ([JIT](https://tailwindcss.com/docs/just-in-time-mode)), [Framer Motion](https://www.framer.com/motion/), and a few other nice bits preconfigured.
## ✨ Features
- [Next](https://nextjs.org/) 12
- [SWC Minification](https://nextjs.org/docs/upgrading#swc-replacing-terser-for-minification)
- [Tailwind](https://tailwindcss.com/) 3.0
- Custom [PostCSS](https://postcss.org/) setup preconfigured to allow for `@import` and simple CSS nesting
- [Framer Motion 4](https://www.framer.com/motion/) (With [LazyMotion](https://www.framer.com/api/motion/lazy-motion/) setup for smaller bundle sizes)
- [Preact](https://preactjs.com/) preconfigured instead of React for smaller bundle size*
- SEO preconfigured with [next-seo](https://github.com/garmeeh/next-seo)
- [Module Aliasing](https://nextjs.org/docs/advanced-features/module-path-aliases) preconfigured with `jsconfig.json`
- [Feature branch](https://github.com/samuelgoddard/next-tailwind-motion/tree/locomotive-scroll) with [Locomotive Scroll](https://locomotivemtl.github.io/locomotive-scroll/) preconfigured for smooth, lerp based page scrolling
- Out the box 100 scores on both mobile & desktop on [Page Speed Insights](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fsg-next-tailwind-motion.vercel.app%2F&tab=mobile)
_*To remove Preact and switch back to React simply remove the code in `next.config.js`_
### Roadmap / Coming Soon...
- Feature branch with [Sanity](https://www.sanity.io/) preconfigured
- Feature branch with [DatoCMS](https://www.datocms.com/) preconfigured
- Feature branch with [GSAP](https://greensock.com/gsap/) preconfigured
## 🚀 Quick start
1. **Clone the repo**
```sh
git clone https://github.com/samuelgoddard/next-tailwind-motion.git
```
2. **Start developing**
Navigate into your new site’s directory and install the local dependencies first, then run the dev command.
```sh
cd next-tailwind-motion/
npm i
npm run dev
```
3. **Open the source code and start editing!**
Your site is will be running at `http://localhost:3000`
## 🗄 Directory Structure
```
|-- components
|-- container.js *// A simple container component to wrap areas in a max width*
|-- fancyLink.js *// A simple wrapper around `next/link`
|-- footer.js *// Example footer component*
|-- header.js *// Example header component*
|-- layout.js *// Layout component that can be used to wrap your pages in a global layout*
|-- helpers
|-- seo.config.js *// default SEO configuration helper, imported in `pages/_app.js`*
|-- transitions.js *// re-usable framer motion transition helper with a basic 'fade' transition to get started*
|-- pages
|-- _app.js *// Includes default SEO component & Framer motion AnimatePresence init*
|-- _document.js *// Default Next document component*
|-- about.js
|-- index.js
|-- public *// Next public assets*
|-- styles
|-- _fonts.css *// custom webfont styles*
|-- _typography.css *// custom typographical styles*
|-- main.css *// Tailwind init and custom css imports*
|-- .gitignore
|-- jsconfig.json *// module aliasing*
|-- postcss.config.js *// Tailwind, CSS import, CSS nesting init*
|-- next.config.js *// Prefer Preact to React*
|-- package.json
|-- README.md
|-- tailwind.config.js
```