Aum Sri Sai Ram

This documentation was built by @lambda (Omkar Reddy K) and @Hursh Gupta (Hursh Gupta) for the benefit of those willing to contribute to the project.

The documentation was tested and refined with the efforts of https://github.com/pgvarma, https://github.com/Saishivam27 and https://github.com/TagoreJ.

Setting up the Dev Machine

Git

1. First login to https://github.com/ (create an account if necessary) and share your GitHub ID with @Hursh Gupta, in order to get access to the main repository (check your email for an invite if you have already done so)

2. Then we need to install these two application on our systems:

   https://git-scm.com/downloads/win

   https://desktop.github.com/download/

   Use the default settings to install both of them.

Node and bun

1. Install the LTS (Long Term Support) which is selected by default in this link:

   https://nodejs.org/en/download/prebuilt-installer

   Download and install with default settings

2. After the installation is done, open up a terminal and run the command to install https://bun.sh/ (you can just run the command below, you don’t need to go to the website)

   npm i -g bun
   

MySQL

1. Download MySQL (v.8.x.x) from this link https://dev.mysql.com/downloads/installer/.
   • requirement: x64 bit
   • Select version v.8.0.x and NOT v.5.x.x version
   • Download the 300+ MB file
   • when prompted: click on no thanks, just start my download (no need to create an account)
2. Next, open the installer as an administrator (which happens by default) and go through the installation with the defaults or recommended settings where ever possible but these two:
   • Select Full installation
   • Config type should remain as Developer Computer
   • Set the root password as sairam (easy to remember, you can set it as anything but have to change it in the .env file we will mention later)
   • For the rest, select the defaults and finally click on execute.

<aside> 😇

The installation process takes time, please be patient.

</aside>

VS code

1. Install vs code if you don't have:

   https://code.visualstudio.com/download

2. Look at this video snippet to learn how to install the required extension in vscode:

   Copy each extension into the extensions search bar and install them. (That “perfect” was accidental, for we didn’t know audio was being recorded 🙄)

   Copy each extension into the extensions search bar and install them. (That “perfect” was accidental, for we didn’t know audio was being recorded 🙄)

   Now, install these one by one.

   bradlc.vscode-tailwindcss
   burkeholland.simple-react-snippets
   dsznajder.es7-react-js-snippets
   esbenp.prettier-vscode
   christian-kohler.path-intellisense
   dbaeumer.vscode-eslint
   eamodio.gitlens
   formulahendry.auto-close-tag
   formulahendry.auto-rename-tag
   oderwat.indent-rainbow
   vincaslt.highlight-matching-tag
   yoavbls.pretty-ts-errors
   wix.vscode-import-cost
   

PowerShell setup