https://github.com/hirotaka/bulletproof-vue

https://github.com/hirotaka/bulletproof-vue

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hirotaka/bulletproof-vue
• Owner: hirotaka
• Created: 2022-09-11T08:31:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-23T07:28:31.000Z (almost 2 years ago)
• Last Synced: 2024-04-29T13:32:46.588Z (6 months ago)
• Language: TypeScript
• Homepage: bulletproof-vue.vercel.app
• Size: 1.03 MB
• Stars: 83
• Watchers: 2
• Forks: 8
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Security: docs/security.md

Awesome Lists containing this project

• awesome-codebases - Bulletproof Vue - A simple, scalable, and powerful architecture for building production ready Vue applications. (**Awesome Codebases** [](https://github.com/sindresorhus/awesome))

README

        
# 🛡️ Bulletproof Vue

A simple, scalable, and powerful architecture for building production ready Vue applications.

This repository is a migration of [bulletproof-react](https://github.com/alan2207/bulletproof-react) to Vue and its ecosystem.

Still work in progress. In particular, items labeled WIP have not yet been migrated.

## Introduction

Vue is a great tool for building frontend applications. It has a very diverse ecosystem with hundreds of great libraries for literally anything you might need. However, it can be overwhelming to be forced to make so many choices.

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

This is an attempt to present a way of creating Vue 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 turns out to be the most effective one.

The goal of this repo is to serve as a collection of resources and good practices when developing Vue applications. It is supposed to showcase solving most of the real-world problems of an application in a practical way and help developers writing better applications.

Feel free to explore the codebase to get the most value out of the repo.

#### Disclaimer:

This is not supposed to be a template, boilerplate or a framework. It is an opinionated guide that shows how to do some things in a certain way. You are not forced 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:

- [💻 Application Overview](docs/application-overview.md)

- [⚙️ Project Configuration](docs/project-configuration.md)

- [👁️ Style Guide](docs/style-guide.md)

- [🗄️ Project Structure](docs/project-structure.md)

- [🧱 Components And Styling](docs/components-and-styling.md)

- [📡 API Layer](docs/api-layer.md)

- [🗃️ State Management](docs/state-management.md)

- [🧪 Testing](docs/testing.md)

- [⚠️ Error Handling](docs/error-handling.md)

- [🔐 Security](docs/security.md)

- [WIP] [🚄 Performance](docs/performance.md)

- [🌐 Deployment](docs/deployment.md)

- [📚 Additional Resources](docs/additional-resources.md)

## Contributing

Contributions are always welcome! If you have any ideas, suggestions, fixes, feel free to contribute. 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](https://choosealicense.com/licenses/mit/)