Skip to content

Commit

Permalink
docs: update README details including updated node version
Browse files Browse the repository at this point in the history
  • Loading branch information
donnyquixotic committed Jun 19, 2023
1 parent e8a640a commit 6f1ed79
Showing 1 changed file with 28 additions and 13 deletions.
41 changes: 28 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,41 +15,56 @@ Teloscan is the official Telos EVM block explorer. Explore accounts, transaction

![Alt](https://repobeats.axiom.co/api/embed/fbc67fae1abc36c6eff5d717f3840280afd1a109.svg "Repobeats analytics image")

## Install the dependencies

Install yarn package manager
Follow the installation instructions at [classic.yarnpkg.com](https://classic.yarnpkg.com/en/)
## Installation

### Install yarn package manager
Follow the installation instructions at [classic.yarnpkg.com](https://classic.yarnpkg.com/en/)

Add Vue and Quasar packages
### Add Vue and Quasar packages
```bash
yarn global add @vue/cli
yarn global add @quasar/cli
```
Clone this repo to your local machine
Copy the example .env file to .env

### Note regarding Node version from [quasar docs](https://quasar.dev/quasar-cli/installation)

Do not use uneven versions of Node i.e. 13, 15, etc. These versions are not tested with Quasar and often cause issues due to their experimental nature. We highly recommend always using the LTS version of Node.

It is recommended to use Node version 16 if you experience issues running the application with other versions.

Using nvm: `nvm use 16`

### Clone repo
```bash
cp .env.example .env
git clone https://github.com/telosnetwork/teloscan
```

### Install the dependencies
```bash
cd teloscan && yarn
```
## Prep the environment
From within the ui-template folder:

### Restore .env file
```bash
yarn
cp .env.example .env
```

## Start the app in development mode (hot-code reloading, error reporting, etc.)
### Start the app in development mode (hot-code reloading, error reporting, etc.)
```bash
yarn dev
```

## Lint the files
### Lint the files
```bash
yarn lint
```

## Build the app for production
### Build the app for production
```bash
yarn build
cd dist/spa
quasar serve
```

## Documentation
Expand Down

0 comments on commit 6f1ed79

Please # to comment.