https://github.com/clonephaze/threejsexpirements

https://github.com/clonephaze/threejsexpirements

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/clonephaze/threejsexpirements
• Owner: Clonephaze
• Created: 2024-09-09T22:32:32.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-11T23:14:27.000Z (2 months ago)
• Last Synced: 2024-09-13T05:48:40.105Z (2 months ago)
• Language: TypeScript
• Homepage: https://clonephaze.github.io/ThreeJsExpirements/
• Size: 1.65 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Project Title

## Table of Contents

- [Project Title](#project-title)

  - [Table of Contents](#table-of-contents)

  - [About ](#about-)

  - [Getting Started ](#getting-started-)

    - [Prerequisites](#prerequisites)

    - [Installing](#installing)

  - [Usage ](#usage-)

## About 

This is a Template structure for creating SPA web applications. 

It uses Webpack to auto compile Typescript, Sass, and HTML into a static index.html file and a single budle.js file.

## Getting Started 

These instructions will get you a copy of the project up and running on your local machine for development. See [usage](#usage) for notes on how to deploy the project on a live system.

### Prerequisites

You will need:

```

Node.js

npm

Webpack and Webpack-CLI

HTML Loader

Typescript + TS Loader

Sass + Sass Loader

```

### Installing

First you will need to install Node.js, you can either download their installer or use their package manager insntallation.

Then clone this repository and run the following command while inside the project directory:

```shell

npm install 

```

You might note theres no index.html file in this project, but it will be created when you build with Webpack.

## Usage 

You will now have everything you need to get started, and can run the following built in commands:

```shell

npm run build

```

This will build the project and output it to the `dist` folder.

```shell

npm run start

```

This will start the project in development mode, and open the browser. Allows for hotswapping code without needing to rebuild.

```shell

npm run watch

```

This will build the project and output it to the `dist` folder just as `npm run build`, but will continue to watch for changes in the input files and rebuild when they change. Useful for using vscode's Live Server.

Remember to change the webpack.config.js to match your project needs, and change the mode from `development` to `production` to build for production. I would remove the mapping as well for production, as it is not necessary.