alexbainter / garden3d

Garden of 3den

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Garden3d

Table of Contents

About The Project

Garden3d is the parent company of Sanctuary Computer, XXIX, Manhattan Hydraulics, among others. This is Garden3d's website, a single splash page with "good" and "evil" modes, and some fun interactivity.

This project was designed by Joel Fear.

The Stack

Here are the major frameworks, programming languages, software and libraries we are using on this project:

Take a look

You can preview Garden3d in it's current state here: Garden3d

Dev

Design

Unfortunately, this project was designed in XD, so all development has been intepreted from PDfs. Please reach out for access.

Getting Started

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

Prerequisites

You need the following libraries and software before you can get the project up and running. Please install them using the steps provided.

  • brew
brew install node
  • yarn
brew install yarn

Installation

  1. Clone the repo
git clone https://github.com/sanctuarycomputer/garden3d.git

To spin up the front-end, follow these steps:

  1. Install packages
yarn install
  1. Spin up the project
yarn start

Project Need-To-Know's

Our Git Process

To learn more about Sanctuary's Git best practices, click here

Branch Naming Conventions

When naming branches, please use the following structure:

  • For new features: feature/<issue-number>-<feature-name-seprated-using-dashes>
  • For updates to existing feautres: update/<issue-number>-<feature-name-seprated-using-dashes>
  • For bug fixes: bugfix/<issue-number>-<bug-name-seprated-using-dashes>

Important Links

Code Style

https://www.notion.so/garden3d/Code-Style-4a5e5835bbab44dd982e4f36d6933e50

Questions?

If you have dev-related questions about this project you can contact: @sepowitz

About

Garden of 3den


Languages

Language:HTML 75.4%Language:JavaScript 14.0%Language:SCSS 10.6%