Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rafaelcamargo/vue-rise
Starter kit for a web client built with Vue
https://github.com/rafaelcamargo/vue-rise
boilerplate circleci eslint firebase jest spa stylus vue webpack
Last synced: about 2 months ago
JSON representation
Starter kit for a web client built with Vue
- Host: GitHub
- URL: https://github.com/rafaelcamargo/vue-rise
- Owner: rafaelcamargo
- Created: 2020-01-25T21:24:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-02T20:02:26.000Z (about 5 years ago)
- Last Synced: 2024-11-05T23:28:05.293Z (3 months ago)
- Topics: boilerplate, circleci, eslint, firebase, jest, spa, stylus, vue, webpack
- Language: JavaScript
- Size: 160 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vue Rise
> Starter kit for a web client built with Vue.
## Contributing
1. Install [Node](https://nodejs.org/en/). Download the "Recommend for Most Users" version.
2. Clone the repo:
``` bash
git clone [email protected]:rafaelcamargo/vue-rise.git
```
3. Go to the project directory
``` bash
cd vue-rise
```
4. Install the project dependencies
``` bash
npm install
```
5. If you want to just build the project, run:
``` bash
npm run build
```
6. Otherwise, run:
``` bash
npm run start
```
The app will be running on `http://localhost:9000`.
## Tests
1. Ensure that all code that you have added is covered with unit tests:
``` bash
npm run test
```
2. You can optionally generate coverage report after running tests:
``` bash
npm run test -- --coverage
```
## Structure
```
- root
- .circleci # Continuous delivery configs.
- config.yml # Continuous integration config (Circle CI).
- deploy.sh # Deploy config (Firebase).
- environments
- src
- images
... # All images go here.
- scripts
- base
- components
- services
- interceptors
- filters
- resources
... # Modules not coupled to any specific domain.
- home
- components
- services
- interceptors
- filters
- resources
- views # Views have no logic, they contain components only.
... # Further domains (user, auth, contact, etc).
- styles
- _variables.styl # Predefined variables (colors, font, etc).
- _mixins.styl # Predefined mixins (placeholder, breakpoint, etc).
- _native.styl # Predefined native styles (body, a, p, ul, li, etc).
... # Further stylesheets go here.
.babelrc # Basic transpilation config.
.eslint # Quality oriented ESLint config.
.jest.config.js # Unit tests config (Jest).
.project.json # General tokens used by config files.
.webpack.conf.base.js # Base bundler configuration (used by all environments).
.webpack.conf.dev.js # Development-specific bundler configuration.
.webpack.conf.prod.js # Production-specific bundler configuration.
.webpack.config.js # Bundler configuration.
```
## Useful links
- [Bottles and principles. How to better organize CSS](https://rafaelcamargo.com/bottles-and-principles-how-to-better-organize-css)
- [Formatting quality](https://rafaelcamargo.com/formatting-quality)
- [Components beyound reuse](https://medium.com/@rcamargo/components-beyond-reuse-6cef6848a748)
- [Component maturity model](https://rafaelcamargo.com/component-maturity-model)
## Questions
Send me your questions clicking [here](https://rafaelcamargo.com/contact)