A learning hub for the Candy Digital web development team.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
node.js > 8.0.0
npm > 6.0.0 or yarn > 1.0.0
Here are the steps you need to run in order to get the project up and running
Change the name of the project in package.json
> npm install
> npm run dev
After setting up the project (see Installing) :
- Vue pages should be included in pages folder.
- Vue components should be included in components folder. Try to keep the project tree organized by creating subfolders according to the page they are used in. Ex: Components used in a homepage should be included in a components/home folder. Components used across many pages should be included in a components/globals folder.
- All styling that should be available across the application should be in assets/sass folder.
- index.scss imports the mixins. Do not add style in that file.
- _animations.scss declares the css animations (useful for Vue Transitions).
- _custom.scss declares custom css (to override plugins styling for instance).
- _fonts.scss declares the fonts.
- _globals.scss declares the global styling to be used across the whole application.
- _mixins.scss declares the cross browser mixins (Like transitions, transform, etc.).
- _variables.scss declares variables that could be reused (colors, sizes).
Please refer to the README files in each folder for more information.
- Nuxt - Server-Side rendering for Vue
- Vue - Front-End Framework
- Jquery - Javascript Library
- Bootstrap 4 - CSS Framework
- SCSS - CSS Library
- CandyDigital - (https://candydigital.co)
This project is licensed under CandyDigital © 2018