Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 1.75 KB

GETTING_STARTED.md

File metadata and controls

51 lines (39 loc) · 1.75 KB
Raw

neo.mjs: Getting Started Guide

The following guide is intended to get this repository running locally.
In case you want to create a neo.mjs App, you have 3 different options:

  1. Use npx neo-app
  2. Fork the neo.mjs workspace
  3. Follow this guide (Step 6 creates a new App inside neo/apps)

Get this repository running locally

  1. Clone this repo to your system to get the project files

    git clone https://github.com/neomjs/neo.git

  2. Open the checked out top level folder inside your terminal

    cd neo

  3. Install the required node modules & run all relevant build scripts at once

    npm run build-all

    (See the Build Scripts Guide for further details.)

  4. Make sure to use a local WebServer!

    • Use a local webserver of your choice (E.g. Webstorm)
    • OR npm run server-start
      1. the dev server will throw 2 errors which you can ignore
      2. a browser tab showing your app opens automatically.

    (JS module imports can not work on the local file system (security).)

  5. Optional: npm run create-app

You can run the examples & docs app without any JS build directly in Google Chrome (v80+):

localhost/neo/docs/

localhost/neo/examples/component/helix/

You can run the dist version examples like this:

These versions also work in Firefox & Safari

localhost/neo/dist/development/examples/component/helix/

localhost/neo/dist/production/examples/component/helix/



Copyright (c) 2015 - today, Tobias Uhlig & Rich Waters