Monorepo

😂 Introduction

Welcome to Hackbeanpot's monorepo! This repository contains both the live site and main site. The reason we have a monorepo is to allow both sites to use the same components from a shared ui folder. VSCode is strongly recommended as a code editor since we have settings configured for Vscode and also use their extensions.

🤪 Getting Started

Clone the repository:

git clone https://github.com/HackBeanpot/mono-repo.git

Change directories

cd mono-repo

Install the packages

# In the project directory
yarn install

Install the ESlint and Prettier VSCode extensions
Cd into the respective project you want to run, yarn install, then yarn develop

📁 File Structure

A quick look at the top-level file structure used

.
├── /husky
├── /vscode
├── /docs
├── /live-site
├── /main-site
├── /node_modules
├── /shared-ui
├── .eslintignore
├── .eslintrc.json
├── .gitignore
├── .prettierrc
├── package.json
├── README.md
├── tsconfig.json
└── yarn.lock

/husky: This directory contains the husky pre-commit hook.
/vscode: This directory contains vscode setting configurations.
/docs: This directory contains the pull request template.
/live-site: This directory contains the project code for the live site.
/main-site: This directory contains the project code for the main site.
/node_modules: This directory contains all of the shared modules of code that the live site, main site, and shared ui depends on (npm packages)are automatically installed.
/shared-ui: This directory contains the shared ui components and styles.
.eslintignore: This file specifies which files should be ignored by eslint
.eslintrc.json: This file configures eslint styling rules
.gitignore: This file tells git which files will not maintain a version history, thus don't need to be tracked.
.prettierrc: This file configures prettier styling rules
package.json: A manifest file for Node.js projects, this file includes the metadata for the project. Metadata includes the project's name, author, etc. This manifest is how npm knows which packages to install to run the project.
README.md: A reference text file containing information about the project.
tsconfig.json: This is a typescript configuration file to specify typescript language checks
yarn.lock: (First see package.json, below) This is an automatically generated file based on the exact versions of your yarn dependencies used for the project. You won't change this file directly.

HackBeanpot/2023-Website

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages