Get the Project Running

Run the project

With the project cloned, you are now ready to install its dependencies and see it running in your browser.


Install dependencies

Every web project relies on external libraries (called dependencies). You need to download these before the project can run. Make sure you are inside the admin folder, then run:

pnpm install

This command reads the project's package.json file and downloads everything the project needs. You will see a progress bar and a list of packages being installed. This may take a minute or two.


Start the development server

Now start the project:

pnpm dev

You will see output that looks something like this:

  VITE v6.x.x  ready in 500ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose

This means the project is running. The development server is a local web server on your computer that serves the project to your browser.


Open it in your browser

Open your web browser (Safari, Chrome, or any browser you prefer) and go to:

http://localhost:5173

You should see the admin login page. You can sign in with any of the demo credentials shown on the page.

Congratulations!

You are now running a real web application on your own computer. Everything you see in the browser is being served from the code on your Desktop.


How to stop the server

When you want to stop the development server, go back to your Terminal and press:

Ctrl + C

This stops the server. The website will no longer load in your browser until you run pnpm dev again.

Keep the server running

For the rest of this workshop, you will want the development server running so you can see your changes in real time. If you accidentally stop it, just run pnpm dev again from the admin folder.

Previous
Clone the repo