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

This is the site for BBG Ventures.

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

• React
• Sanity.io
• Basement CSS

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

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

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

1. Clone the repo

git clone https://github.com/sanctuarycomputer/bbgv.git

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

1. Install NPM packages

yarn install

2. Spin up the project

yarn start

To spin up the CMS, navigate to cms and follow these steps:

1. Spin up the CMS

sanity start

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.

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

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>

https://www.notion.so/garden3d/BBG-Ventures-974544cdcfb64807b7d004cc97ca1fcf

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

If you have dev-related questions about this project you can contact: Christine Kim