Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 1.84 KB

GETTING_STARTED.md

File metadata and controls

56 lines (43 loc) · 1.84 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

    npm install

  4. Run all relevant build scripts at once

    npm run build-all

(See the Command-Line Interface for further details.)

  1. Make sure to use a local WebServer!

    • Use a local webserver of your choice (E.g. Webstorm)
    • OR npm run server-start
      1. A browser tab showing your app opens automatically.
      2. You can also manually access it: http://localhost:8080/

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

  2. Optional: npm run create-app

You can run the examples & docs app without any JS build directly in Chromium (Chrome, Edge) or Safari Tech Preview:

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