@slicemachine/init

@slicemachine/init

The easiest way to add Slice Machine to your project.

• 🏗️  Installs Slice Machine as a development dependency.
• 🪄  Automatically detects and installs the correct framework adapter (Next.js and Nuxt are supported).
• ✏️  Walks you through creating a new Prismic content repository.

Quick Start

First, create a Next.js or Nuxt app if you don't already have one:

npx create-next-app

# or

npx nuxi init your-app-name

Then, run @slicemachine/init:

cd your-app-name
npx @slicemachine/init

Slice Machine is now ready to run!

npm run slicemachine

Documentation

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-2023 Prismic <[e-mail]> (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.