Skip to content

My boilerplate for faster development of next.js applications

License

Notifications You must be signed in to change notification settings

MikeyZat/next-js-starter-pack

Repository files navigation

Welcome to Next.js starter pack!

Hours of configuring your project before you can code anything useful - is it just me or everyone hates it?

Motivation

The initial goal was to create a boilerplate which would help me and other developers to start their Next.js applications without the headache caused by configuring all the necessary things. As a React development-kit I choose antd-design - quite fresh and promising library. However, due to lack of time, the projects is still in progress and is not likely to be finished soon.

What's included

  • Next.js
  • Typescript
  • react-intl (support for multi-languages)
  • Babel
  • Eslint
  • Prettier
  • Custom webpack configuration (including useful aliases)
  • Nodemon (hot reloading)
  • antd-design
  • Redux & redux-toolkit

What should be added to the mix

  • Good support for styles (working well with Next & antd)
  • dockerfile
  • General support for deploying the app

How to use

This repository is free to use and extend. Follow these steps to run it on your machine:

  • git clone https://github.com/MikeyZat/next-js-starter-pack.git
  • cd next-js-starter-pack
  • npm install
  • npm run dev

Look into the console and you should see the compilation process. After it's finished:

  • open your browser
  • Go to http://localhost:3000
  • See the landing page
  • Edit and play with the app in whatever way you like 😄

🙌 Contributing

If you want to further develop this project, I would be more than happy 😁

To contribute, follow steps below:

  • fork the repository
  • create your branch following name conventions (feat/some-feature or bug/some-bug)
  • apply your changes
  • test your changes (not only in positive scenarios)
  • commit your changes and add meaningful commit message
  • push your changes and made a PR with exact description what changes it delivers
  • assign me for a review
  • enjoy your contribution ✔️

📝 License

Developed under the MIT license and yeah, that's good news.

Contributors


Mikołaj Zatorski

About

My boilerplate for faster development of next.js applications

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published