Giter VIP home page Giter VIP logo

webgl-seed's Introduction

Cover Art

WebGL Seed

License Unit Tests Dependency Status devDependency Status

A simple hello triangle example you could use to as a basis when starting WebGL.

Setup

First install:

Then type the following in any terminal your such as VS Code's Integrated Terminal.

# πŸ‘ Clone the repo
git clone https://github.com/alaingalvan/webgl-seed

# πŸ’Ώ go inside the folder
cd webgl-seed

# πŸ”¨ Start building the project
npm start

Refer to this blog post on designing web libraries and apps for more details on Node.js, packages, etc.

Project Layout

As your project becomes more complex, you'll want to separate files and organize your application to something more akin to a game or renderer, check out this post on game engine architecture and this one on real time renderer architecture for more details.

β”œβ”€ πŸ“‚ node_modules/   # πŸ‘Ά Dependencies
β”‚  β”œβ”€ πŸ“ gl-matrix      # βž• Linear Algebra
β”‚  └─ πŸ“ ...            # πŸ•š Other Dependencies (TypeScript, Webpack, etc.)
β”œβ”€ πŸ“‚ src/            # 🌟 Source Files
β”‚  β”œβ”€ πŸ“„ renderer.ts    # πŸ”Ί Triangle Renderer
β”‚  └─ πŸ“„ main.ts        # 🏁 Application Main
β”œβ”€ πŸ“„ .gitignore      # πŸ‘οΈ Ignore certain files in git repo
β”œβ”€ πŸ“„ package.json    # πŸ“¦ Node Package File
β”œβ”€ πŸ“„ license.md      # βš–οΈ Your License (Unlicense)
└─ πŸ“ƒreadme.md        # πŸ“– Read Me!

Some key dependencies are:

  • gl-matrix - WebGL's best linear algebra library, perfect for people used to linear algebra libraries like GLM or the built in GLSL data structures.

  • Webpack - Compiles our TypeScript files and creates binaries for us to use.

  • TypeScript - JavaScript with types, makes it significantly easier to program web apps with instant autocomplete and type checking.

webgl-seed's People

Contributors

alaingalvan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

webgl-seed's Issues

Include engine declaration in package.json file

Please consider including the minimum required version for NodeJS on the package.json file.

{ "engines" : { "node" : ">=12.0" } }

I don't know what the exact version is, but I do know that the current webpack version needs at least a 10.13.0 version and trying to run this with an older version fails rather unhelpfully.

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.