Awesome

Table Of Contents

• Features
• Getting Started
• One click deploy
• Built With
• Contributing
  • Creating A Pull Request
• Acknowledgements
• Contributors
• License

Features

• ⚡ Next.js - React framework for static rendering
• Best SEO setup - Meta Tags, JSON-LD and Open Graph Tags
• Tina CMS integration - local & (optional) production CMS
• Optimized for Web Vitals
• Blog with MDX
• Mailchimp Integration - for newsletters
• Sendgrid Integration - for sending emails
• Dark mode - and customizable themes!
• No UI library - just styled components, so you don't have to learn any new syntax
• One click deployment - with Vercel or any other serverless deployment environment
• Eslint - with Next.js's recommended settings and imports sorting rule
• Prettier

🤓 Getting Started

• Click Use the template or this link
• Setup your sendgrid API key and add it to environment variables (SENDGRID_API_KEY - .env.local)
• Adjust the template to your needs (and checkout env.ts file)
• Deploy the project on Vercel don't forget to add env variables
• (optional) Create Tina Cloud account, a project and fill these NEXT_PUBLIC_ORGANIZATION_NAME, NEXT_PUBLIC_TINA_CLIENT_ID env vars with proper values

  Tina's Content API authenticates directly with GitHub removing the need for users to create GitHub accounts. Access is granted through the dashboard, allowing users to login directly through your site and begin editing! Any changes that are saved by your editors will be commited to the configured branch in your GitHub repository.

  • For more details see the docs

# run the dev mode
$ yarn dev

# run the prod mode
yarn start

# build the app
yarn build

Hint: To edit the blog pages go to /admin and navigate to a blog page to edit it. To exit editing mode navigate to /admin/logout

🚀 One click deploy

Clone the repository and one-click deploy to Vercel for free!

Clone the repository and one-click deploy to Netlify for free!

🧰 Built With

• Statically generated pages with Next.js
• Styled components
• MDX
• TypeScript

🤲🏻 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

😎 Acknowledgements

Big thanks to authors of these libraries:

• https://github.com/neg4n/next-api-og-image - generating open graph images
• https://github.com/blazity/nextjs-color-mode - non-flickering dark mode
• https://github.com/Brew-Brew/css-in-js-media - a convenient way of creating media queries

Support

If you're looking for help or simply want to share your thoughts about the project, we encourage you to join our Discord community. Here's the link: https://blazity.com/discord. It's a space where we exchange ideas and help one another. Everyone's input is appreciated, and we look forward to welcoming you.

✨ Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

📝 License

Distributed under the MIT License. See LICENSE for more information.