Skip to content

Latest commit

 

History

History
175 lines (125 loc) · 7.22 KB

README.md

File metadata and controls

175 lines (125 loc) · 7.22 KB

Contributors Forks Stargazers Issues MIT License


Logo

Three.js Starter Template

Get your Three.js projects up and running quickly with this modular, manageable template, based on Lewy Blue’s Discover Three.js. I use this template as a common starting point for Three.js articles on my blog.

View Demo · Report Bug · Request Feature

About The Project

For more information, see my blog post A Three.js Starter Template. For general background, including a step-by-step walkthrough of building a similarly-structured application, see Discover Threee.js, starting from Chapter 1-3, "Introducing the World App."

Product Name Screen Shot

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

To be able to run the project in a local server, you’ll need to have Node.js and NPM installed.

Installation

  1. Clone the repo
    git clone https://github.com/pnichols04/three-js-starter-template.git
  2. Install NPM packages
    npm install

(back to top)

Usage

Run the project in a local server

npm run serve

For more examples, please refer to the blog post

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Your Name - @PhilipNichols04 - philip.j.nichols@gmail.com

Project Link: https://github.com/pnichols04/three-js-starter-template

(back to top)

Acknowledgments

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Not affiliated with or endorsed by Lewy Blue or Discover Three.js.

(back to top)