atmasark / ttmf

🌌 Project TTMF - Render groovy WebGL content using PixiJs

Project TTMF

This is a Gatsby.js application which uses PixiJs to render WebGL content. The website is intended to be used as sort of a screensaver, which will show its true self when combined with a right amount of some sweet elevator tunes.

Live application: https://ttmf.netlify.com/

🚀 Quick start

1. Clone this repository

   Clone this repository git clone https://github.com/atmasark/ttmf

2. Install dependencies

   Navigate into the main directory and run the following command to install all dependencies.

   cd ttmf/
   npm install

3. Start developing.

   Start up the application.

   gatsby develop

   Psst. To get the application running on your LAN (and be able to run the site on other devices in the same network), run the following command instead

   gatsby develop -H 0.0.0.0

   The address to access the site on your network will be shown in the console.

4. Open the source code and start editing!

   Your site is now running at http://localhost:8000!

   Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

   Open the ttmf directory in your code editor of choice and edit src/components/Home.jsx. Save your changes and the browser will update in real time!

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
  ├── components
  ├── images
  ├── layout
  ├── pages
  ├── styles
├── .gitignore
├── .prettierrc
├── gatsby-config.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

• /src/components: This is the directory most of the contributions should be located in.

• /src/images: All the images used on the website belong here.

• /src/layout: This is a higher level layout file, which connects global styles and style related files on the application.

• /src/pages: The pages are set here. To add a new page, just add a new .jsx file here.

• /src/styles: Global styles should be set here, more precisely in /src/styles/styles.css.

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

5. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

6. LICENSE: Gatsby is licensed under the MIT license.

7. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

8. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

9. README.md: A text file containing useful reference information about your project.