Kickdrum University Documentation

website·Indexed 30 days ago

https://kickdrum.github.io/kickdrum-university

Onboarding and training resources for software engineers, featuring tutorials and exercises on Linux command line, Git SCM, Java (including OOPs), TypeScript, JavaScript, HTML, CSS, and SQL database management. Includes guides on using linters and software engineering best practices.

Tokens
3.7K
Snippets
23
Records
40
Agent score
75%

What's inside Kickdrum University

  1. Run Linux commands on Windows

    Standard Linux/Unix commands do not run directly in Windows PowerShell. To execute these commands on Windows, use Git Bash (installed as part of the Git installation), which provides a UNIX terminal environment. Alternatively, advanced users can dual-boot a Linux distribution such as Ubuntu or Zorin OS.
  2. Set up and run the JavaScript introductory exercises

    To begin the JavaScript exercises, navigate to the /javascript folder of the repository and install the dependencies. The exercises consist of implementing logic for a calculator and a counter based on comments found in their respective index.html files. A hot-reload server is provided to preview changes on localhost.
    # Install dependencies
    npm install
    
    # Run the calculator site
    npm run start:calc
    
    # Run the counter site
    npm run start:count
  3. Run linting and tests for JS/TS assignments

    After running the repository initialization script, JavaScript and TypeScript assignments are configured with ESLint for linting, and Jest and Cypress for test suites. To avoid the commit loop, you can manually trigger these checks using npm scripts.
    npm run lint # Run linting checks
    npm run test # Run test suites
  4. Create a feature branch and submit a Pull Request

    Follow these steps to create a new branch, add a file, commit changes, and initiate a Pull Request (PR) against the main branch.

    1. Create a new branch named PRE-KDU-1 from the main branch.
    2. Create a README.md file with a personal introduction.
    3. Commit the file with the message: "PRE-KDU-1: Added README.md file".
    4. Push the changes to the remote repository.
    5. Create a Pull Request from PRE-KDU-1 to the main branch.
    6. Grant repository access to the user gowreswaran.
    # Create and switch to a new branch
    git checkout -b PRE-KDU-1
    
    # Create README.md
    echo "Feel Free to add a cool intro about yourself in the README" > README.md
    
    # Commit and push
    git add README.md
    git commit -m "PRE-KDU-1: Added README.md file"
    git push origin PRE-KDU-1
  5. Install PostgreSQL on Windows, macOS, and Linux

    Follow these steps to install and configure PostgreSQL based on your operating system:

    Windows:

    1. Download the PostgreSQL installer from the official website.
    2. Run the installer and follow the on-screen instructions.
    3. Access PostgreSQL via the command line or the pgAdmin tool.

    macOS:

    1. Install via Homebrew.
    2. Start the PostgreSQL service.

    Linux (Ubuntu/Debian):

    1. Update package lists and install postgresql and postgresql-contrib using apt.
    2. Start the PostgreSQL service.
    # macOS
    brew install postgresql
    brew services start postgresql
    
    # Linux (Ubuntu/Debian)
    sudo apt update
    sudo apt install postgresql postgresql-contrib
    sudo service postgresql start
  6. Set up and run TypeScript exercises

    To work on the TypeScript exercises, navigate to the /typescript folder in the provided GitHub repository and open it in an editor like VS Code. Install dependencies using npm and execute specific question files (e.g., q1.ts) using the provided npm script to verify output in the console. You can refer to .test.ts files to understand the required test cases.
    # Install dependencies
    npm install
    
    # Run a specific question file (e.g., q1.ts)
    npm run tsc q1.ts
  7. Set up the JavaScript development environment

    To develop with JavaScript, install Node.js and NPM version 22.0 or above. During the Node.js installation process, it is recommended to enable all checkboxes related to dependencies to ensure a complete setup.
    # Verify Node.js version
    node --version
    
    # Verify NPM version
    npm --version
  8. Complete Java exercises in the kickdrum-university repository

    Locate the /java folder in your created GitHub repository and open it in an IDE (such as VS Code or IntelliJ). Complete the coding tasks by reading the instructions provided as comments at the beginning of the following files, adding your implementation inside the Parent class:

    • CollectionsExample.java
    • CSVWordFrequency.java
    • StringComparison.java
  9. Install and Verify Java JDK 21

    The Java Development Kit (JDK) is required for Java development. It is critical to install JDK version 21 specifically to ensure compatibility with configured assignments.
    # Download JDK 21 from: https://www.oracle.com/java/technologies/downloads/
    
    # Verify the installation
    java --version