Skip to content

Commit

Permalink
Update overview.md
Browse files Browse the repository at this point in the history
Updated overview with Andy's suggestions

+ moved all instructions for running locally to the getting started section

+ adding a new feature guide for Explorer Sandbox
  • Loading branch information
elenananana authored Oct 4, 2023
1 parent 81458a5 commit fe9f888
Showing 1 changed file with 3 additions and 19 deletions.
22 changes: 3 additions & 19 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,8 @@
Title: Overview
---

# Explorer Overview
# Stacks Explorer Overview

The Explorer frontend user interface is built with [React](https://reactjs.org/), [next.js](https://github.com/vercel/next.js) and [@stacks/ui](https://github.com/hirosystems/ui).
The Stacks Explorer is an observability tool that helps users, developers, miners, and investors understand the Stacks Blockchain. It's built with [React](https://reactjs.org/), [next.js](https://github.com/vercel/next.js) and [Chakra UI](https://chakra-ui.com/). Developers cal also deploy and execute contracts through the browser-based Explorer Sandbox.

Before you can run Explorer on your machine locally, you must first clone the [Explorer](https://github.com/hirosystems/explorer) repository to obtain all of the necessary files and libraries needed.

# Project Dependencies

Once you have cloned the Explorer repositories, you will need to install the following project dependencies:

- [NodeJS](https://nodejs.dev/en/) that includes `npm`
- [PNPM](https://pnpm.io/installation/)
- [Homebrew](https://brew.sh/)

> **_NOTE:_**
>
> Although Homebrew is not required to install and operate Explorer, it is highly recommended.
Open your terminal window, and make sure you are in the `/explorer` folder. Run the below command to install the dependencies:

`pnpm i`
For instructions on how to run the Stacks Explorer on your machine locally, check out the [Getting Started](https://docs.hiro.so/explorer/getting-started) guide. To learn more about the Explorer Sandbox, refer to the feature guide LINK TBD.

0 comments on commit fe9f888

Please sign in to comment.