Nextjs boilerplate clean architecture

An awesome clean architecture boilerplate to bootstrap your project was develop using typescript and nextjs.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• You shouldn't be doing the same tasks over and over like creating a README from scratch
• You should implement DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

Use the BLANK_README.md to get started.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 
• 
• 
• 
• 
• 
• React-Query
• Husky
• Storybook

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/zaidanammar/nextjs-boilerplate-clean-architecture.git

2. Install NPM packages

   npm install or yarn install

3. Enter your configuration project in .env.local, in a module you will work on

   NEXT_PUBLIC_API = 'ENTER YOUR SECRET KEY';

(back to top)

Usage

How to run a project, please follow the instructions below.

1. Run the Project

npm run dev or yarn dev

How to run a storybook, please follow the instructions below.

1. Run the storybook in local

npm run dev:storybook or yarn dev:storybook

(back to top)

Roadmap

• develop clean architecture structure
• Add documentation in storybook
• add unit testing components

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Muammar Zaidan - @zaidanammar - zaidanammar23@gmail.com

Project Link: https://github.com/zaidanammar/nextjs-boilerplate-clean-architecture

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Img Shields
• React Icons

(back to top)