Kickdrum University Documentation
website·Indexed 30 days ago
https://kickdrum.github.io/kickdrum-universityOnboarding 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.
What's inside Kickdrum University
- Effective debugging is essential for Java development. Resources are available for both major IDEs: Eclipse provides a 'Debug Perspective' for application analysis, and IntelliJ IDEA offers a visual debugging process.
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.Set up and run the JavaScript introductory exercises
To begin the JavaScript exercises, navigate to the/javascriptfolder 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 respectiveindex.htmlfiles. 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:countRun 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 suitesCreate 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.
- Create a new branch named
PRE-KDU-1from the main branch. - Create a
README.mdfile with a personal introduction. - Commit the file with the message: "PRE-KDU-1: Added README.md file".
- Push the changes to the remote repository.
- Create a Pull Request from
PRE-KDU-1to themainbranch. - 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- Create a new branch named
Add VSCode to the system shell path
To open VSCode directly from the command line, add thecodecommand to your shell path. Open the Command Palette in VSCode and select the option:Install 'code' command in PATH.Install PostgreSQL on Windows, macOS, and Linux
Follow these steps to install and configure PostgreSQL based on your operating system:
Windows:
- Download the PostgreSQL installer from the official website.
- Run the installer and follow the on-screen instructions.
- Access PostgreSQL via the command line or the pgAdmin tool.
macOS:
- Install via Homebrew.
- Start the PostgreSQL service.
Linux (Ubuntu/Debian):
- Update package lists and install
postgresqlandpostgresql-contribusingapt. - 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 startSubmit TypeScript exercise solutions
When submitting your solutions, ensure you are inside thetypescriptfolder. Commit all changes to a new branch namedPRE-KDU-TYPESCRIPT. Commit messages must follow the naming convention:PRE-KDU-TYPESCRIPT: Your_commit_message.Set up and run TypeScript exercises
To work on the TypeScript exercises, navigate to the/typescriptfolder 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.tsfiles to understand the required test cases.# Install dependencies npm install # Run a specific question file (e.g., q1.ts) npm run tsc q1.tsSet 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 --versionComplete Java exercises in the kickdrum-university repository
Locate the
/javafolder 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.javaCSVWordFrequency.javaStringComparison.java
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