Quickstart
Get started quickly. Learn how to setup the project.
HZ Design Group
System Requirements
Setup
- Make sure to add your GitHub token to your
"~/.bash-profile"(for bash terminal) or"~/.zprofile"(for zsh terminal) - In this project everything runs off the
".npmrc"file. Make sure the".npmrc"file that you have in the main directory contains:
registry=https://registry.npmjs.com/
@hzdg:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN_OR_A_REFERENCE_TO_IT
- To install autoenv, run each of the following commands:
brew install autoenv
echo "source $(brew --prefix autoenv)/activate.sh" >> ~/.bash_profile
- Install packages via yarn in root directory
yarn install
Setup - Contentful Sync API
- Follow the instructions in "web/schemas/README.md"
Command Reference
These commands should be run from the root of the project
| COMMAND | DESCRIPTION |
|---|---|
yarn dev | Starts the application in development mode with hot-code reloading, error reporting, and more. The application will start at http://localhost:3000 by default. |
yarn prebuild | TBD |
yarn build | Creates an optimized production build of your application |
yarn storybook | Creates and serves a development version of storybook. The application will start at http://localhost:6006 by default |
yarn syncContentful | Downloads and syncs, creates, and updates Contentful content models on your local environment. |
Hosting Environment
--- Main Branch ---
Development URL - https://evrealestate.netlify.app
Storybook URL - https://ev-storybook.netlify.app
Creating Components
Make sure to import new components inside "web/components/BlockMapper/BlockMapList.ts"
- Additional instructions are found in
"web/components/BlockMapper/README.md"
Creating Components - ULTRAFAST (optional)
- Run your local and run the syncContentful script (
yarn syncContentful) - Visit any page on your local, scroll to the bottom of the page and click the "New Component" button.
- Click the checkmarks for any file you want to auto generate
Please note: autogeneration skips files that already exist, it does not overwrite any files for safety