There are also several other documents covering most of the functions and setup of this Vue boilerplate.
Don't forget to populate all of the project placeholders with proper data based
on the project at hand. You can easily find these by doing a search for TODO
in the project either with git grep or your IDE of choice.
-
Click the big green download button on this repository and download a ZIP of the project. This zip will include every single file you need to boot this boilerplate up for another project. Make sure you can see hidden files before proceeding to extract.
-
Create a new repository to house your project.
Initialize the repository with a README and pick node for the gitignore.
-
Now that you have your new repository go ahead and clone it over on to your computer using either command line or GUI.
-
Extract the zip you downloaded on step 1 into the repository you just cloned. Let it overwrite any existing files (Readme, gitignore usually).
-
Open up
package.jsonfile and modify the project name accordingly. You might wish to do a search for TODO on the project to find other placeholders that need to be changed to match the project data. -
Run
npm installand after it completes runnpm run devto make sure everything is working as intended. -
Commit and push your repository! We now have a new project ready to roll and collaborate on with the rest of the team.
Black Mesa aims to be a ready-to-deploy barebones boilerplate for web applications of small to medium size without any modification. It features: a full webpack 2.0 implementation with linting, testing, internationalization, browser-caching, state management, authentication (firebase) and .gz compression.
Support for large traffic or bigger applications can easily be added since the architecture is built on scaleable principles with modular components throughout.
Powered by Node.js and Vue.js
For More Information Please View The Documents Section
The main philosophy behind this project and why it was born is quite simple. Providing a quick and clean reactive/SPA deployment that can be setup quickly by any individual or team and that will auto-enforce best practices and QA. With the hope that Fast deployment + Best practices = less bugs and better quality. And we all know that less bugs = more 🍻
BlackMesa can be deployed by cloning this repository and running the dev-environment.sh script in the Setup Folder to install all dependencies, setup Git and run the project.
There is also a Vagrant deployment utilizing Ubuntu as a way to ensure environment consistency in a development team or to easily work with remote teams.
Keep the code clean and follow a few best practices and in the long run your team and your business will thank you. One of the main goals of BlackMesa is to reduce technical debt as much as possible by taking a proactive approach to development. Altough the linting programs help, they are no substitue for a proper review process.
Everything is a module or a component of some sort and can and SHOULD be swapped to fit the project's needs.
Lets face it, we all hate slow websites on mobile - so why would we build slow websites ourselves? This project takes performance seriously.
🔺Node.js 🔺Vue.JS 🔺Vue-X 🔺Webpack 🔺Linting 🔺SASS 🔺MAGIC