/threejs-code-journal

Three.js daily code journal experiments

Primary LanguageJavaScriptMIT LicenseMIT

Three.js Code Journal

Welcome to the Three.js Code Journal. This repository serves as a daily log of code exercises focused on Three.js. Each exercise or project is organized by date, making it easy to track your progress and revisit previous work.

Folder Structure

The folder structure is organized by year, month, and day. Each exercise or project is contained in its own folder.

threejs-code-journal/
├── README.md
├── index.html
├── gallery.js
├── exercises/
│   ├── YYYY/
│   │   ├── MM/
│   │   │   ├── DD/
│   │   │   │   ├── exercise-N/
│   │   │   │   │   ├── index.html
│   │   │   │   │   ├── script.js
│   │   │   │   │   └── style.css
  • YYYY/MM/DD/exercise-N/: Contains the code for each exercise or project.

Getting Started

Follow these steps to get started with your own journaling journey:

  1. Clone the repository: git clone https://github.com/nyxtom/threejs-code-journal.git

  2. Navigate to the folder of the desired exercise: cd threejs-code-journal/exercises/YYYY/MM/DD/exercise-N

  3. Open index.html in your browser to see the exercise in action.

Adding Your Own Exercises

Feel free to use this repository as a template for your own journaling journey. Here's how you can add your own exercises:

  1. Create a new folder for your exercise: mkdir -p exercises/YYYY/MM/DD/exercise-N

  2. Add your code files (index.html, script.js, style.css) to the new folder.

  3. Commit and push your changes: git add . git commit -m "Add exercise N for YYYY-MM-DD" git push origin main

Contributing

We welcome contributions from the community. If you have an exercise or project you'd like to share, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your contribution.
  3. Add your exercise or project to the appropriate folder.
  4. Submit a pull request with a brief description of your contribution.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Happy coding and journaling.