Shanti Project

This project is designed and developed by a team of UC Berkeley students through one of Cal Blueprint's project teams during the 2022-23 academic year.

Learn more about Shanti Project and Cal Blueprint.

---

Getting Started

Check your installation of npm and node:

node -v
npm -v

We strongly recommend using a Node version manager like nvm (for Mac) or nvm-windows (for Windows) to install Node.js and npm. See Downloading and installing Node.js and npm.

Installation

1. Clone the repo & install dependencies
   1. Clone this repo
      • using SSH (recommended)

        git clone git@github.com:calblueprint/shanti-project.git

      • using HTTPS

        git clone https://github.com/calblueprint/shanti-project.git

   2. Enter the cloned directory

      cd shanti-project

   3. Install project dependencies. This command installs all packages from package.json.

      npm install

2. Set up secrets: TBD

Helpful resources

• GitHub: Cloning a Repository
• GitHub: Generating SSH keys

Development Environment

• VSCode (recommended)
  1. Open the shanti-project project in VSCode.
  2. Install recommended workspace VSCode extensions. You should see a pop-up on the bottom right to "install the recommended extensions for this repository".

Running the app

1. In the project directory, run:

    npm run dev

2. Open up http://localhost:3000 in your browser to see the results.