Skip to content

A simple, scalable, and powerful architecture for building production-ready Nuxt full-stack applications.

License

Notifications You must be signed in to change notification settings

hirotaka/pragmatic-nuxt

Repository files navigation

🛡️ The Pragmatic Nuxt

A simple, scalable, and powerful architecture for building production-ready Nuxt full-stack applications.

Warning

The purpose of this repository is to help me learn how to build practical Nuxt3 applications for myself.

I am building a full-stack Nuxt application using a variety of technology stacks with Bulletproof React as a reference.

This repository is still in the process of development. Please note that it is not yet production-ready.

Introduction

Nuxt is an excellent tool for building full-stack applications based on Vue. It has a diverse ecosystem with hundreds of great libraries for anything you need. However, being forced to make so many choices can be overwhelming.

Vue is very flexible, you can write Vue applications in any way you like, but that flexibility comes with a cost. Since no pre-defined architecture developers can follow, it often leads to messy, inconsistent, or over-complicated codebases.

Nuxt calls itself an intuitive framework. Nuxt provides a framework for building a full-stack application with a front-end built in Vue and a different back-end. It offers a lot, but developers still need to make many decisions, such as authentication or testing mechanisms.

This repository presents a way of creating Nuxt applications using the best tools in the ecosystem with a good project structure that scales very well. It is based on the experience of working with many different codebases, and this architecture is the most effective one.

This repo aims to serve as a collection of resources and sound practices when developing Nuxt applications. It is supposed to showcase solving most of the real-world problems of an application practically and help developers write better applications.

Feel free to explore the codebase to get the most value from the repo.

Disclaimer:

This repository should not be a template, boilerplate, or framework, it is an opinionated guide that shows how to do some things in a certain way. You are free to do everything exactly as it is shown here. Decide what works best for you and your team, and stay consistent with your style.

Table Of Contents:

The followings are works in progress. Coming soon...

  • ⚙️ Project Configuration
  • 👁️ Style Guide
  • 🗄️ Project Structure
  • 🧱 Components And Styling
  • 📡 API Layer
  • 🗃️ State Management
  • 🧪 Testing
  • ⚠️ Error Handling
  • 🔐 Security
  • 🚄 Performance
  • 🌐 Deployment
  • 📚 Additional Resources

Contributing

Contributions are always welcome! Feel free to contribute if you have any ideas, suggestions, or fixes. You can do that by going through the following steps:

  1. Clone this repo
  2. Create a branch: git checkout -b your-feature
  3. Make some changes
  4. Test your changes
  5. Push your branch and open a Pull Request

License

MIT

Reference

This repository is heavily inspired by bulletproof-react. It also cites much of the documentation. I appreciate for making excellent content available on OSS!

About

A simple, scalable, and powerful architecture for building production-ready Nuxt full-stack applications.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published