README
Dolphin
This is Dolphin, our design framework made upon our Vue.js bootstrap.
Features
- Thorough documentation: Written with the same care as Vue's core docs to quickly train new team members and consolidate knowledge.
- Guaranteed consistency: Opinionated linting for Vue, JavaScript/JSON, SCSS, and Markdown, integrated into Atom and run against staged files on pre-commit.
- First-class tests: Practice test-driven development with Jest unit tests.
- Speedy development: Between configurable generators, handy aliases, and global base components, your productivity will skyrocket.
Getting started
# 1. Clone the repository.
git clone git@bitbucket.org:loandolphin/dolphin-framework.git
# 2. Enter your newly-cloned folder
cd dolphin-framework
Documentation
This project includes a docs folder with more details on the following subjects.
If you are a front-end developer we strongly recommend reading it.
- Setup and development
- Architecture
- Languages and technologies
- Routing, layouts, and views
- State management
- Tests and mocking the API
- Linting and formatting
- Building and deploying to production
- Troubleshooting
Fast up and running (for non-frontenders only)
# Install packages
make bootstrap
# Launch the dev server and automatically open it in
# your default browser when ready
make run
# Run unit tests
make test
FAQ
Why should I clone this bootstrap instead of generating a new project with Vue CLI directly?
Vue CLI aims for flexibility, making it as simple as possible for any team to set up a new project, no matter how big or small, whether it's an app or a library, or what languages and technologies are being used.
This boilerplate makes more assumptions. It assumes you're building a large app, possibly developed by a large team. It also makes a lot of default choices for you, based on what tends to work well for large, enterprise projects. At the same time, it aims to educate and empower users to configure these defaults to ideally suit their specific app and team.
We decided it should be a standard.