Giter VIP home page Giter VIP logo

slice-machine's Introduction

Slice Machine logo

Develop and work with Prismic Slices, locally.

Slice Machine

npm downloads npm version Github Actions CI License

Quickstart

For the smoothest onboarding experience, go to Prismic, create an account, create a new repository, and choose a starter project. You will be guided through a full introduction to Slice Machine.

If you want to dive in without any guidance, follow these steps:

Create a Next.js or Nuxt app:

npx create-next-app@latest my-app
npx nuxi@latest init my-app

Open the folder:

cd my-app

Install dependencies:

npm i

Init Slice Machine:

npx @slicemachine/init

Open two terminals. In one terminal, run the web app:

npm run dev

In the other, run Slice Machine:

npm run slicemachine

Now you can use Slice Machine to create content models for your website. You will push your models to Prismic, where editors can use them to create content.

You will need to query content from the Prismic API to use it in your application. To learn how to use the Prismic API, visit the Prismic Documentation.

Documentation

To discover what's new on this package check out the changelog. For full documentation, visit the official Prismic documentation.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a PR with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

License

   Copyright 2013-2021 Prismic <[email protected]> (https://prismic.io)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

slice-machine's People

Contributors

alexgalays avatar angeloashmore avatar arnaudlewis avatar bapmrl avatar benjammartin avatar btkostner avatar chengoconnell avatar chriz001 avatar dani-mp avatar danielbego avatar danigo99 avatar dependabot[bot] avatar duaner avatar gijsbotje avatar heyrows avatar hypervillain avatar lihbr avatar marcmcintosh avatar mathieud avatar mdeclercq avatar michelchau avatar miniplop avatar noxdzine avatar redian avatar samlfair avatar shainegordon avatar sintinilorenzo avatar snaer-yolabs avatar varunbalakrishna avatar xrutayisire avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.