Nu Nu

Table of Contents

• About the Project
  • The Stack
• Getting Started
  • Prerequisites
  • Installation
  • VSCode Extenstions
• Project Need To Know's
  • Styleguide
• Our Git Process
  • Branch Naming Conventions
• Important Links
  • Project Wiki
  • Code Style
• Questions?

About The Project

INDEX is a community space promoting access, support and good vibrations within the creative disciplines.

The Stack

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

Dev

• Liquid
• Basement CSS
• Shopify Bookings
• Accentuate Custom Fields for Shopify

Design

We are using Figma for our design comps. Here is the link to the design files. If you need access, please contact XXIX.

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/nunu.git

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

1. Install NPM packages

yarn install

2. Spin up the project

yarn watch

Development

NOTE: If you're currently running theme watch from a different feature, please kill that process before following the below steps!

1. Create a feature branch in Git (feature/843-product-grid)
2. Login to the Shopify Admin, navigate to Online Store -> Themes and duplicate a theme. Name it the same as your branch name, click Customize and grab its ID from the URL bar.
3. Set that ID in your theme/.env file as DEVELOPMENT_THEME_ID.
4. Run yarn deploy to ensure your theme is now in sync with the compiled assets.
5. You're now ready to develop! Run yarn watch, and changes to the local files will be compiled and sync'd to your new theme.
6. In order to preview your development theme, head to the Shopify Admin, find your theme, and under Actions click Preview.

Deployment

NOTE: The following process will ensure we never overwrite the production theme accidentally.

1. Preview the theme you would like to set live
2. Under Actions, click Duplicate.
3. Rename the duplicated theme Production #{n+1} (the live theme should be Production #{n})
4. Under Actions, click Publish.

VSCode Extensions

We highly recommend using VSCode for this project and adding the following extensions:

If you are not using VSCode, please check to see if you editor has an equivalent for the listed extentions and install.

Project Need-To-Know's

Styleguide

View Default Page style guide at /pages/default-page-style-guide

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 features: update/<issue-number>-<feature-name-seprated-using-dashes>
• For bug fixes: bugfix/<issue-number>-<bug-name-seprated-using-dashes>

Important Links

Project Wiki

https://www.notion.so/garden3d/Index-Wiki-075d0ae6c06740a48bf5933106d95724

Code Style

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

Questions?

If you have dev-related questions about this project you can contact: Conor Davidson Sebastian Odell Christine Kim