Git Product home page Git Product logo

generator-ju's Introduction

generator-ju

Easily generate Ju webapps and components using Yo

Getting started

From zero to nihao world in a few steps.

Creating a new project

npm install -g generator-ju
  • Run CLI util and answer all the questions
yo ju

Running your project using docker

We provide a docker container with nginx webserver, as it is required to load resources (like HTML files) from the browser. To use it:

  1. Install docker
  2. Install docker-compose
  3. In the generated project root, run:
docker-compose up -d

Testing the generated app

If the installation was fine, you can go to http://localhost:8080 and you should see a message saying "nihao Ju!".

Please note that you can also test your app by opening the index.html file located at your_project_root/public, but you won't be able to dynamically load resources.

Next steps

Refer to the Github repositories of Ju framework for details about app development:

Generating Ju components

Run yo ju:components and answers all the questions.

You will obtain a basic component that can handle resources and remote data.

Generating Ju Object-Oriented Javascript modules

Run yo ju:module and answers all the questions.

You will obtain a class like structure, either using plain prototypes (module), a class with inheritance, singleton and static members or everything plus observer pattern.

Generating Ju Models

Run yo ju:model and specify the Model Definition name, the file name and path, and the middleware you wish to add (AJAX and WebStorage providers are avilable now, there are more in the way).

You will obtain a Model definition, that you can modify to inject middleware to every API method, to instatiate it later and perform data operations.

Generating README files

Run yo ju:readme and follow the steps to generate a README markdown file for your library (:

It will include common sections, like getting started, references and all the stuff you may want to make a good documentation

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.