Running Locally

Set up your local environment to run Framer-ground.

Framer-ground is built using Next.js, TailwindCSS and Framer-motion. To run Framer-ground locally, you need to have Node.js installed on your machine. You can follow the steps below to set up your local environment.

Getting Started

Please follow these simple steps to get a local copy up and running.

Prerequisites

Here is what you need to be able to run Framer-ground.

  • Node.js (Version: >=18.x)
  • pnpm _(recommended)
  • Basic understanding of Framer motion animation library

Development

Setup

  1. Clone the repo into a public GitHub repository (or fork https://github.com/code-env/Framer-ground/fork).

    git clone https://github.com/code-env/Framer-ground.git

  2. Go to the project folder

    cd Framer-ground

  3. Install packages with pnpm

    pnpm install

  4. Set up your .env file

    • Duplicate .env.example to .env

  5. Setup Node

    If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project:

    nvm use

    You first might need to install the specific version and then use it:

    nvm install && nvm use

    You can install nvm from here.

  6. Start the development server

    pnpm dev

  7. Open http://localhost:3000 in the browser to see the result.

Edit this page on GitHub
OverviewAdding components