This document outlines the system requirements for developing and running the DevOps Journey project.
We provide a setup script that automatically installs all required dependencies. To use it, run:
# Using the Makefile (recommended)
make setup
# Or directly
./setup.shThe setup script will:
- Detect your operating system
- Install or update Node.js to the required version
- Install pnpm package manager
- Install project dependencies
The script supports the following operating systems:
- Debian/Ubuntu
- Fedora
- RHEL/CentOS
- Arch Linux
- macOS
- Windows (limited support, may require manual installation)
If you prefer to set up your environment manually, you'll need:
-
Node.js - Version 16.0 or higher
- Download from: https://nodejs.org/
- Verify with:
node -v
-
npm - Usually comes with Node.js
- Verify with:
npm -v
- Verify with:
-
pnpm (recommended) or yarn
- Install with:
npm install -g pnpm - Verify with:
pnpm -v
- Install with:
- Docker - For containerized development and deployment
- Download from: https://www.docker.com/get-started
- Verify with:
docker -v
After installing the required software, set up the project:
# Clone the repository
git clone https://github.com/ismoilovdevml/devops-journey.git
cd devops-journey
# Install dependencies
npm install --legacy-peer-deps
# or with pnpm
pnpm install
# Start development server
npm run dev
# or with pnpm
pnpm devIf you encounter permission issues when installing global packages, try:
# Using sudo (Linux/macOS)
sudo npm install -g pnpm
# Or configure npm to use a different directory
npm config set prefix ~/.npm
export PATH="$HOME/.npm/bin:$PATH"
# Add the export line to your .bashrc or .zshrcIf you have an older version of Node.js and can't update it system-wide, consider using a version manager:
- nvm (Node Version Manager): https://github.com/nvm-sh/nvm
- n (Node version management): https://github.com/tj/n
If you're having trouble with Docker, ensure:
- Docker daemon is running:
sudo systemctl start docker - Your user is in the docker group:
sudo usermod -aG docker $USER - You've logged out and back in after adding yourself to the docker group
For more details on project setup and development, see:
- README.md - General project information
- CONTRIBUTING.md - How to contribute to the project
- IMPROVEMENTS.md - Recent improvements to the project