diff --git a/README.md b/README.md index f55a763..2bd313b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,37 @@ > Tippy is still under active development and considered to be a work in progress. +![Tippy](tippy.png) + +## Getting Started + +You can download Tippy binary for your platform of choice from the [releases](https://github.com/nervosnetwork/tippy/releases) page. + +Tippy is pre-built as self-contained .Net Core application. You don't have to install .Net Core to run it. If you're running it on Linux or macOS and want to use the Debugger feature, please install debugger dependencies following [this](#install-dependencies) section. + +### On Windows: + +* Download `tippy-win-x64.zip` +* Extract the zip file (default to `tippy-win-x64`) +* Enter `tippy-win-x64` folder and click `Tippy.exe` to start + +### On Linux: + +* Download `tippy-linux-x64.tar.gz` +* Extract the tar.gz file (default to `tippy-linux-x64`) +* Make `Tippy` executable: `chmod +x ./tippy-linux-x64/Tippy` +* `cd tippy-linux-x64` then run `./Tippy` to start + +### On macOS: + +* Download `Tippy.dmg` +* Open the dmg file and drag `Tippy.app` to `/Applications` folder +* From `/Applications` click `Tippy.app` to start + +### Tippy Console and UI + +While Tippy runs as a console application, it also provides web UI. By default the dashboard UI will be opened automatically, if not you can access it by visiting [http://localhost:5000/Home](http://localhost:5000/Home) from a browser. + ## Install Dependencies Transaction debugger requires `ttyd` and `gdb 10` @@ -23,9 +54,9 @@ brew install ttyd *Note: debugger is not supported on Windows.* -## Getting Started +## Contributing -1. Fetch the codebase: `git clone --recursive https://github.com/nervosnetwork/tippy.git` +1. Fetch the codebase: `git clone https://github.com/nervosnetwork/tippy.git` 2. Install [.NET Core SDK](https://www.microsoft.com/net/download) 5.0 3. Install CKB related binary dependencies: ```shell @@ -37,14 +68,22 @@ brew install ttyd ``` 4. Open `Tippy.sln` with Visual Studio 2019 (v16.8 or later), Visual Studio 2019 for Mac (v8.8 or later), or Visual Studio Code 5. Select `Tippy` as startup project for the solution, then start debugging it -6. Browse `http://localhost:5000/home` in your browser (if it's not opened automatically) +6. Browse `http://localhost:5000/home` in your browser + +### Add Database Migration + +`EF` models are located in `Tippy.Core` project. When making any changes to them and migration is needed, run this + +```shell +dotnet ef migrations add [MigrationName] --project src/Tippy.Core --startup-project src/Tippy +``` -## Add Database Migration +Or open `Package Manager Console` in Visual Studio, select `Tippy.Core` as `Default project`, then run ```shell -dotnet ef migrations add [MigrationName] --project src/Tippy.Core --startup-project src/Tippy +Add-Migration [MigrationName] ``` ## Design -Tippy's page design is baded on [mazipan/bulma-admin-dashboard-template](https://github.com/mazipan/bulma-admin-dashboard-template). +Tippy's page design is based on [mazipan/bulma-admin-dashboard-template](https://github.com/mazipan/bulma-admin-dashboard-template). diff --git a/src/Tippy/Pages/Blocks/Index.cshtml b/src/Tippy/Pages/Blocks/Index.cshtml index 801fc3f..3fe3435 100644 --- a/src/Tippy/Pages/Blocks/Index.cshtml +++ b/src/Tippy/Pages/Blocks/Index.cshtml @@ -89,6 +89,19 @@ --> + + @section scripts { + + } } else { diff --git a/src/Tippy/Pages/Blocks/_Search.cshtml b/src/Tippy/Pages/Blocks/_Search.cshtml index b378097..b23f7a2 100644 --- a/src/Tippy/Pages/Blocks/_Search.cshtml +++ b/src/Tippy/Pages/Blocks/_Search.cshtml @@ -1,6 +1,6 @@ 
- +
- -
- -
- } - else - { -
- -
- } - } - - - -
-
- - - -
- -
- - - -
+ @if (Model.ActiveProject != null && ProcessManager.IsRunning(Model.ActiveProject)) + { + + } + diff --git a/src/Tippy/Pages/Shared/_NavbarStatus.cshtml b/src/Tippy/Pages/Shared/_NavbarStatus.cshtml new file mode 100644 index 0000000..db79d89 --- /dev/null +++ b/src/Tippy/Pages/Shared/_NavbarStatus.cshtml @@ -0,0 +1,100 @@ +@model Tippy.Pages.PageModelBase +@using Tippy.Ctrl; +@using Tippy.Util; + +
+
Current Block
+ @if (Model.ActiveProject != null && ProcessManager.IsRunning(Model.ActiveProject)) + { +
@Model.TipBlockNumber
+ } + else + { +
NA
+ } +
+ +
+ +
+
Epoch
+ @if (Model.EpochView != null) + { +
@Hex.HexToUInt64(Model.EpochView!.Number)
+ } + else + { +
NA
+ } +
+ + diff --git a/src/Tippy/Tippy.csproj b/src/Tippy/Tippy.csproj index b60bb25..3106805 100644 --- a/src/Tippy/Tippy.csproj +++ b/src/Tippy/Tippy.csproj @@ -8,7 +8,7 @@ false embedded 6e0dc08b-01f2-47f6-8249-66ed1b18f469 - 0.1.7 + 0.1.8 https://github.com/nervosnetwork/tippy https://github.com/nervosnetwork/tippy Copyright (c) Nervos Foundation diff --git a/src/Tippy/wwwroot/js/site.js b/src/Tippy/wwwroot/js/site.js index b0ba9ef..db9a11f 100644 --- a/src/Tippy/wwwroot/js/site.js +++ b/src/Tippy/wwwroot/js/site.js @@ -57,15 +57,6 @@ document.addEventListener('DOMContentLoaded', function () { var sidebarToggler = document.querySelector('#sidebar-toggler-button') var sidebar = document.querySelector('#main-sidebar') - sidebarToggler.addEventListener('click', function () { - sidebar.classList.toggle('closed') - if (sidebar.classList.contains('closed')) { - withChildren.forEach(function (wChildrenEl) { - wChildrenEl.classList.remove('open') - }) - } - }) - // Notification Animate var $notifIcons = document.querySelectorAll('.nav-tag > span > i') if ($notifIcons.length > 0) { diff --git a/tippy.png b/tippy.png new file mode 100644 index 0000000..a2d58e4 Binary files /dev/null and b/tippy.png differ diff --git a/tools/osx/Info.plist b/tools/osx/Info.plist index 3fdf10b..641cb17 100644 --- a/tools/osx/Info.plist +++ b/tools/osx/Info.plist @@ -9,9 +9,9 @@ CFBundleIconFile Tippy.icns CFBundleVersion - 0.1.7 + 0.1.8 CFBundleShortVersionString - 0.1.7 + 0.1.8 CFBundleExecutable main CFBundleInfoDictionaryVersion