Skip to content

1. Getting Started

Jump to bottom
Joni Roine edited this page Mar 6, 2025 · 3 revisions

Getting Started with the Project

Welcome to the project setup guide! This document will help you configure the project locally on your machine, ensuring a smooth development experience. Follow the steps below to get everything up and running.

⚙️ Prerequisites

Before you begin, please ensure you have the following tools installed on your computer:

  • GitHub Desktop – A user-friendly application for managing Git repositories.
  • Visual Studio Code or Webstorm – Both are powerful IDEs. VS Code is versatile and lightweight, while WebStorm is optimized for web development.
  • Node.JS – A runtime environment and library that is used for running web applications.
  • Environment Files – These will be provided to you separately.

Note:
If you prefer a different approach to development, ensure you are familiar with how to use GitHub Personal Access Tokens (PATs) to run our environment.
Refer to the PAT Instructions for setup and usage guidance.

🚀 Step-by-Step Setup

1. Clone the Repository from GitHub

  1. Navigate to the Altzone Web-Pages repository on GitHub and ensure you're on the main branch.

  2. Click the Code button to reveal the repository URL.

    Code button on GitHub

  3. Confirm that the URL is correct, then select Open with GitHub Desktop.

    Open with GitHub Desktop

2. Set Up the Project Locally

  1. In GitHub Desktop, verify the URL again and choose your preferred local directory for the project.

  2. Click Clone to download the repository to your local machine.

    Clone in GitHub Desktop

3. Switch to the dev Branch

  1. Once cloning is complete, switch to the dev branch (if you're a developer).

  2. Click Open in Visual Studio Code to launch the project in your IDE.

    Open in Visual Studio Code

4. Add Environment Files

  1. In Visual Studio Code, navigate to the project folder named frontend-next-migration.

  2. Add the provided .env file to the root directory of the project.

    Add .env file

🛠 Install Dependencies and Start the Project

Now that your project is set up, it’s time to install the necessary dependencies and start the development server. Choose the appropriate package manager for your setup:

Note: The installation commands below are required only during the initial setup. If you have already installed the dependencies, you can skip this step.

Commands

# Navigate to correct path (root directory where package manager runs)
cd frontend-next-migration

# Using npm
# Install dependencies
npm install
# If you are getting an error with this command you most likely are missing the package manager that comes with Node.JS. 
# Check that you have Node.JS installed by typing "node" in CMD
# If command reads "Welcome to Node.js" restart your computer and try again.

# Start the development server
npm run dev

If all steps have been successfully completed, you can now access the project at http://localhost:5173/.

Clone this wiki locally