This website was created with the purpose of better organizing all my saved places on google maps, and so that I can more easily find the places that I want to go or have been.
- Add more icons
- Add filters for places
- Add more data interactions
- Maybe add d3? or Three?
Developer experience first:
- 🔥 Next.js for Static Site Generator
- 🎨 Integrate with Tailwind CSS
- 💅 PostCSS for processing Tailwind CSS and integrated to
styled-jsx - 🎉 Type-checking TypeScript
- ✅ Strict Mode for TypeScript and React 17
- ✏️ Linter with ESLint (default NextJS, NextJS Core Web Vitals, Tailwind CSS, and Airbnb configuration)
- 💡 Absolute Imports
- 🛠 Code Formatter with Prettier
- 🦊 Husky for Git Hooks
- 🚫 Lint-staged for running linters on Git staged files
- 🗂 VSCode configuration: Debug, Settings, Tasks, and extension for PostCSS, ESLint, Prettier, TypeScript
- 🤖 SEO metadata, JSON-LD, and Open Graph tags with Next SEO
- ⚙️ Bundler Analyzer
- 🖱️ One-click deployment with Vercel or Netlify (or manual deployment to any hosting services)
- 🌈 Include a FREE minimalist theme
- 💯 Maximize lighthouse score
- 🧩 Progresive web App
Built-in feature from Next.js:
- ☕ Minify HTML & CSS
- 💨 Live reload
- ✅ Cache busting
- Minimal code
- SEO-friendly
- 🚀 Production-ready
- Create the app maskable icon
- Generate the icons and manifest.json files
- publish the app anywhere with [PWA Builder](https://www.pwabuilder.com/
- Check the /layout/Meta for all metadata :)
- Node.js 14+ and npm
Run the following command on your local environment:
git clone --depth=1 https://github.com/lertsoft/typescript-ventures.git my-project-name
cd my-project-name
npm install
Then, you can run locally in development mode with live reload:
npm run dev
Open http://localhost:3000 with your favorite browser to see your project.
.
├── README.md # README file
├── next.config.js # Next JS configuration
├── public # Public folder
│ └── assets
│ └── images # Image used by default template
├── src
│ ├── layout # Atomic layout components
│ ├── pages # Next JS pages
│ ├── styles # PostCSS style folder with Tailwind
│ ├── templates # Default template
│ └── utils # Utility folder
| └── components # Components folder
| └── types # Types interfaces and/or declarations
| └── data # Data for the maps. GeoJson.
├── tailwind.config.js # Tailwind CSS configuration
└── tsconfig.json # TypeScript configuration
You can easily configure Next.tsx Boilerplate. Please change the following file:
public/apple-touch-icon.png,public/favicon.ico,public/favicon-16x16.pngandpublic/favicon-32x32.png: your website favicon, you can generate from https://favicon.io/favicon-converter/src/styles/global.css: your CSS file using Tailwind CSSsrc/utils/AppConfig.ts: configuration filesrc/templates/Main.tsx: default theme
You can see the results locally in production mode with:
$ npm run build
$ npm run start
The generated HTML and CSS files are minified (built-in feature from Next js). It will also remove unused CSS from Tailwind CSS.
You can create an optimized production build with:
npm run build-prod
Now, your blog is ready to be deployed. All generated files are located in out folder, which you can deploy with any hosting service.
Clone this repository on your own GitHub account and deploy it to Netlify:
[
Deploy this Next JS Boilerplate on Vercel in one click:
[]
If you are a VSCode user, you can have better integration with VSCode by installing the suggested extension in .vscode/extension.json. The starter code comes up with Settings for seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.
Pro tips: if you need a project-wide type checking with TypeScript, you can run a build with Cmd + Shift + B on Mac.
Everyone is welcome to contribute to this project. Feel free to open an issue if you have a question or found a bug.
Licensed under the MIT License, Copyright © 2022
See LICENSE for more information.