@aualrxse/quick-sand NPM

A Project is based on Next.js.

To know more about Next.js, see README_NEXT.md.

Installation

$ npm install

$ npx quick-sand create -name [PROJECT_NAME]

$ npx quick-sand create -name Trail

$ npx quick-sand create --n Trail --ts

option	short hand	description
-name [PROJECT_NAME]	--n	A module name following the -name qualifier.
-typescript	--ts	A module which is created is written in TypeScript.

You can start editing the page by modifying

The page auto-updates as you edit the file.

src/pages/projects/[PROJECT_NAME].jsx

src/lib/webgl/projects/[PROJECT_NAME]/main.js

WebGLBase

name	access	type
init()	public	method
deInit()	public	method
render()	public	method
_onInit()	protected	method
_onDeInit()	protected	method
_onResize()	protected	method
_onUpdate()	protected	method
_scene	protected	Scene
_renderer	protected	WebGLRenderer
_camera	protected	_PerspectiveCameara \| _OrthographicCamera
_canvas	protected	HTMLCanvasElement
_settings	protected	WebGLOptions
_elapsedTime	number	Elapsed time from last initialization

src/styles/projects/[PROJECT_NAME].module.scss

path	description
src/api	Any modules that sends some request to outer API.
src/components	React (.jsx, .tsx) components.
src/constants	Constants
src/pages	When a file is added to the this directory, it's automatically available as a route. See here
src/styles	Stylesheets
src/types	Type declaration files.
src/utils	Utility functions etc.
src/lib	Any libraries that doesn't depend on components.