mixn / slice-machine

A machine made to slice stuff (mostly components)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Slice Machine Draft README

A library of reusable, high-quality website sections to be used in your own Nuxt project - with and without Prismic.

Make sure to view the complete list of components here, or scroll down if want to contribute! 👇

⭐️Oh and star us on GitHub — it helps

Motivation

Developing websites sometimes feels tedious and redundant. In addition to choosing a framework and build tools, you'll need to design the same components over again and find a way to feed them with content.

We believe that Nuxt has already made the process of creating modern websites a lot faster and that VueSlices

Vue-slices is a project that aims at helping both developers and designers make websites 10x faster.

What was the motivation for this project being built in the first place? What types of projects would this project be a good fit for, and when might something else be better?

Getting started

First iteration is pretty simple: copy-paste what you like and start using the components.

👇 For Prismic users

If you're already used to building websites with Prismic, think of this library as a solution to kickstart your project or custom type in a matter of minutes. We offer you both the code and the model you need to create the slice in the writing room.

  1. Select the slice components you want to use
  2. Copy paste their respective model.json in the writing room
  3. Add the slices folder to your projects
  4. Import the slices in your ``

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Polyfills

  • focus-visible.min.js
  • which uses classList, that you should polyfill too
  • CSS Vars should be ponyfilled

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

P.S

  • This repo is under active development. If you have any improvements / suggestions please file an issue or send in a Pull Request
  • The TODO.md file or the issues page are a good place to visit if you want to pick up some task. They have a list of things are to be implemented in the near future

About

A machine made to slice stuff (mostly components)

License:MIT License


Languages

Language:JavaScript 39.2%Language:CSS 23.2%Language:HTML 22.9%Language:Vue 14.7%