Needlessly Postulating Minds

    slice-machine-ui

    0.5.2 • Public • Published

    Slice Machine logo

    A visual builder for your Slice Models with all the tools you need to generate data models and mock CMS content locally.

    Slice Machine

    npm version npm downloads Github Actions CI Conventional Commits License

    • 🔪  Create slices locally;
    • 📄  Manage your custom types;
    • 🖼  Storybook integrated workflow.

    Install

    npx @slicemachine/init

    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.

    Development scripts

    To start the SliceMachine locally you need to :

    1. Install the project dependencies

    make install

    1. Run the SliceMachine backend (express server) into a first terminal

    cd packages/slice-machine && npm run dev-server

    1. Run the SliceMachine frontend (next server) into a second terminal

    cd packages/slice-machine && npm run dev

    1. Open the SliceMachine in your browser http://localhost:9999
    2. (optional) When working on the @slicemachine/core package you have to run an extra watcher

    cd packages/core && npm run watch

    SliceMachine is organized as a monorepo using Lerna. Useful scripts include:

    make clean

    a command that clean all the project dependencies and reinstall the SliceMachine from scratch

    npm run test

    boolean check if unit tests all pass - uses jest

    npm run lint

    boolean check if code conforms to linting rules - uses eslint

    License

       Copyright 2013-2021 Prismic <contact@prismic.io> (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.
    

    Keywords

    none

    Install

    npm i slice-machine-ui

    DownloadsWeekly Downloads

    16,270

    Version

    0.5.2

    License

    MIT

    Unpacked Size

    27.1 MB

    Total Files

    655

    Last publish

    Collaborators

    • arnaudlewis
    • sprite
    • hypervillain
    • amaurycahuet
    • lihbr