Pre-requisites

Note: These installation instructions are provided as a guideline. Environments differ, so if you run into issues, you can troubleshoot by consulting the relevant official documentation or searching for solutions on the internet.

1. Database Setup (PostgreSQL)

# Update package lists and install PostgreSQL
sudo apt update
sudo apt install postgresql postgresql-contrib -y

# Validate installation
psql --version
sudo systemctl status postgresql --no-pager

Create User and Database:

1. Create a user: sudo -u postgres createuser --interactive
2. Set password: sudo -u postgres psql -c "ALTER USER <user> WITH PASSWORD '<password>';"
3. Create database: sudo -u postgres createdb <dbname>
4. Validate: sudo -u postgres psql -c "\du"

# Install PostgreSQL using Homebrew
brew install postgresql

# Start the PostgreSQL service
brew services start postgresql

# Validate installation
psql --version
brew services list

Create User and Database:

1. Create a user: createuser --interactive
2. Create database: createdb <dbname>
3. Access psql: psql -d <dbname>
   • Inside psql, set password: ALTER USER <user> WITH PASSWORD '<password>';

1. Install via Chocolatey (Recommended):

   choco install postgresql

2. Or, download the installer from the PostgreSQL official website.
3. During installation, you will be prompted to set a password for the default postgres user and select a port.

Create User and Database:

• Use the pgAdmin tool that comes with the installation to create a new user and database via a graphical interface.

2. Git Installation

sudo apt update
sudo apt install git -y

If you have Homebrew, it's as simple as:

brew install git

Alternatively, installing Xcode Command Line Tools will also install Git.

The easiest way is to download and install Git for Windows.

Validate and Configure Git:

# Validate installation
git --version

# Configure your user details (essential for commits)
git config --global user.name "Your Name"
git config --global user.email "youremail@example.com"

# Check your configuration
git config --list

3. Node.js & npm (via nvm)

We highly recommend using Node Version Manager (nvm) to manage multiple Node.js versions.

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

# You may need to restart your terminal or run the following commands:
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

# Validate nvm installation
nvm --version

# Install the latest LTS version of Node.js (Recommended)
nvm install --lts

# Set the installed version as default
nvm alias default 'lts/*'

For Windows, nvm-windows is the recommended tool. Download and run the installer from the releases page.

# Validate nvm installation
nvm version

# Install the latest LTS version
nvm install lts

# Use the installed version
nvm use <version_number> # e.g., nvm use 20.11.0

Validate Node.js and npm:

node -v
npm -v

4. Project-Specific Tools

SolidX uses several command-line tools for code generation and file operations. The best practice is to install these as local project dependencies so they don't conflict with other projects.

You will install these in a later step when you create your SolidX project. When you need to run them, you will use npx, which executes commands from your local node_modules folder.

• @angular-devkit/schematics-cli: Used for generating backend controllers and services.
• copyfiles: Used for copying static files during the build process.

No installation is required at this stage. The npx @solidstarters/create-solid-app command in the next step will set up a project with these dependencies included.