Giter VIP home page Giter VIP logo

Comments (3)

genemars avatar genemars commented on June 1, 2024 1

That's ok. You can start as a end-user, and use the library for your projects. Especially because you're a beginner you can help more in finding out the best way to improve the documentation and the library itself.

from zuix.

genemars avatar genemars commented on June 1, 2024

A good starting point is the CONTRIBUTING.md file.
II'll write down some additional backgrounds.
This project does not use any transpiler option and the source code is written in a compatible way, so that just merging the files will create a valid file of the library.
This process is anyway automated with some scripts that make use of:

  • browserify
    that generates zuix.js and zuix-bundler.js. The starting point for the first one is ./src/main.js, while for the latter is ./src/bundler.js.
  • google-closure
    to make code verification against ECMASCRIPT6_STRICT and to generate minified versions of the libraries with relative .map files.
  • dox
    to generate the JSON files out of JSDoc comments used in the source code. These files are used to display the API documentation in the website. It also generate the TypeScript definition file.

The scrips are located in the ./build folder.

The source code is structured in classes obtained with closures, the use of prototype and JSDoc comments, in a way that migrating to the use of the class facility will be straightforward.

If there's more you want to know just ask.

from zuix.

yemkhaung avatar yemkhaung commented on June 1, 2024

@genemars Honestly, I think I need to google the terms you just used to make sense of them and connect the dots.
Sorry, beginner here. 😅

I'll start at contributor documentation and I'll put more questions later.

Thanks for the explanation.

from zuix.

Related Issues (12)

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.