Skip to content

unegbuclinton/vid-pod

Repository files navigation

Getting Started on Vidpod

Follow these steps to set up and run the project on your local machine:

Prerequisites

Make sure you have the following installed on your system:

Installation

  1. Clone the repository:

    Open your terminal and run the following command to clone the repository:

    git clone https://github.com/unegbuclinton/Vidpod.git
    
  2. Navigate to the project directory::

    Change into the directory where the project is located:

    cd Vidpod
    
  3. Navigate to the project branch::

    Change into the branch where the project is located:

    git checkout main
    
  4. Install dependencies::

    Run the following command to install all necessary dependencies:

    Note

    Please confirm your node version, be sure to run on node version 20.12 or higher. Lesser versions raised some dependency errors.

    npm install
    
  5. Environment Variables::

    You do not need to update the .env file as it has been disabled in the .gitignore file. All necessary environment variables are already configured.

  6. Running the Project::

    Once the dependencies are installed, you can start the development server with the following command:

    npm run dev
    

    This will launch the project in development mode. You can then open your browser and visit http://localhost:3000 or the chosen port to view the application.

  7. Deployment url::

    You can also open the project with the deployed link

    https://vid-pod.vercel.app/
    

    Thank you ROX