Meteor Vue Enterprise Starter
An opinionated starter kit application utilizing the following libraries/frameworks, with an emphasis on code modularity:
- Meteor 1.6
- Vue 2
- vuex 2
- vue-router 2
- iView UI toolkit
The following development tools are used:
- Jest - unit tests
- Chimp - e2e tests
- semistandard - code linting
- meteor-husky - git hooks
- CircleCI - continuous integration
Note: This starter kit is geared towards enterprise software. If you're looking to put together a quick prototype, this may be overkill.
First, clone this repo
git clone https://github.com/ejfrancis/Meteor-Vue-Enterprise-Starter
Then enter the new directory where it was cloned into, and install dependencies:
cd Meteor-Vue-Enterprise-Starter meteor npm install
Now to run the application:
meteor npm start
To run the app with a production bundle and using the production settings located at
meteor npm run start:mimic-prod
UI Framework Components
The iView UI framework is used for reusable, uniform components for things like form inputs, buttons, and a responsive grid layout. See the documentation of iView for more information on the components available.
You can provide application config/settings values in the
config/ directory, which will be made available via
Meteor.settings in your code. You'll see two files:
config/config.development.json: local config, used when
meteor npm startis run
config/config.production.json: production config, use this for production values. (see the Meteor guide)
See the Unit Tests documentation.
See the E2E Tests documentation.
Code linting is done with semistandard, which is a pre-configured eslint that works out of the box with an opinionated ruleset. Run code linting with this command:
meteor npm run lint
To automatically fix linting errors, run:
meteor npm run lint:fix
Routing is done on the client with VueRouter. The router configuration is located at src/imports/modules/router/client/lib/router.js.
Client State Management with Vuex
See the Vuex State Management documentation.
The directory structure is built in a way to make things predictable and enforce code modularity and organization per feature/domain by splitting the code into "Application Modules".
See the Application Structure documentation.
A CircleCI configuration for running code linting, unit tests, and e2e tests against a local app server is located in
.circle/config.yml. If the build is taking too long, you can split the unit tests and code linting into one job, and e2e tests in another job with a CircleCI Workflow.