diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..31ad24c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,17 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +* version: +* project (e.g. CLI): +* operating system: + +## Description + +## Steps to reproduce + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d06e4700 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# Contributing to Dnote + +This repository contains the server side and the client side code for Dnote. + +## Set up + +1. Download and setup the [Go programming language](https://golang.org/dl/). +2. Download the project + +```sh +go get github.com/dnote/dnote +``` + +## CLI + +### Set up + +Download dependencies using [dep](https://github.com/golang/dep). + +```sh +dep ensure +``` + +### Test + +Run: + +```sh +./cli/scripts/test.sh +``` + +### Debug + +Run Dnote with `DNOTE_DEBUG=1` to print debugging statements. + +### Release + +* Build for all target platforms, tag, push tags +* Release on GitHub and [Dnote Homebrew tap](https://github.com/dnote/homebrew-dnote). + +```sh +VERSION=0.4.8 make release +``` + +* Build, without releasing, for all target platforms + +```sh +VERSION=0.4.8 make +``` + +**Note** + +- If a release is not stable, + - disable the homebrew release by commenting out relevant code in the release script. + - mark release as pre-release on GitHub release + +## Web + +### Set up + +Download dependencies using [dep](https://github.com/golang/dep) and npm. + +```sh +dep ensure +npm install +``` + +### Test + +Run: + +``` +npm run test +``` + +## Server + +### Set up + +Download dependencies using [dep](https://github.com/golang/dep). + +```sh +dep ensure +``` + +### Test + +Run: + +``` +./server/api/scripts/test-local.sh +``` diff --git a/README.md b/README.md index c76c6d6d..58c3dfff 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,63 @@ -# Dnote +![Dnote](assets/logo.png) +========================= -A simple notebook for developers. +Dnote is a simple notebook for developers. -## What It Does +[![Build Status](https://semaphoreci.com/api/v1/dnote/dnote-2/branches/master/badge.svg)](https://semaphoreci.com/dnote/dnote-2) -Write technical notes and neatly organize them into books. +## What is Dnote? -## How to Use +Dnote is a lightweight notebook for writing technical notes and neatly organizing them into books. The main design goal is to **keep you focused** by providing a way of swiftly capturing new information **without having to switch environment**. To that end, you can use Dnote as a command line interface, browser extension, web client, or an IDE plugin. -You can use Dnote in a command line, web browser, or in an IDE. +It also offers **end-to-end encrypted** backup with AES-256, and **automated spaced repetition** to retain your memory in case you are building a personal knowledge base. -- [CLI](https://github.com/dnote/dnote/tree/master/cli) -- [Web](https://dnote.io) -- [Browser extension](https://github.com/dnote/browser-extension) -- [Atom](https://github.com/dnote/dnote-atom) +For more details, see the [download page](https://dnote.io/download) and [features](https://dnote.io/pricing). -It is designed to minimize switching environment. +## Quick install -## Privacy +The quickest way to try Dnote is to install the command line interface. -Dnote is end-to-end encrypted with AES-256 to respect your privacy. It does not track you. +### Install with Homebrew -## Self-host +On macOS, you can install using Homebrew: -Instructions are coming soon. +```sh +brew tap dnote/dnote +brew install dnote -## User Stories +# to upgrade to the latest version +brew upgrade dnote +``` + +### Install with script + +You can use the installation script to install the latest version: + + curl -s https://raw.githubusercontent.com/dnote/dnote/master/cli/install.sh | sh + +In some cases, you might need an elevated permission: + + curl -s https://raw.githubusercontent.com/dnote/dnote/master/cli/install.sh | sudo sh + +### Install with tarball + +You can download the binary for your platform manually from the [releases page](https://github.com/dnote/dnote/releases). + +## Personal knowledge base + +Dnote is great for building a personal knowledge base because: + +* It is fully open source. +* Your data is stored locally first and in a SQLite format which is [suitable for continued accessibility](https://www.sqlite.org/locrsf.html). +* It provides a way of instantly capturing new lessons without distracting you. +* It automates spaced repetition to help you retain your memory. + +You can read more in the following user stories: - [How I Built a Personal Knowledge Base for Myself](https://dnote.io/blog/how-i-built-personal-knowledge-base-for-myself/) - [I Wrote Down Everything I Learned While Programming for a Month](https://dnote.io/blog/writing-everything-i-learn-coding-for-a-month/) -## Links +## See Also -- [Dnote](https://dnote.io) -- [Dnote Pro](https://dnote.io/pricing) +- [Homepage](https://dnote.io) - [Forum](https://forum.dnote.io) - -[![Build Status](https://semaphoreci.com/api/v1/dnote/dnote-2/branches/master/badge.svg)](https://semaphoreci.com/dnote/dnote-2) diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 00000000..e446301e Binary files /dev/null and b/assets/logo.png differ diff --git a/cli/CONBTRIBUTING.md b/cli/CONBTRIBUTING.md deleted file mode 100644 index ec5f3e4c..00000000 --- a/cli/CONBTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Contributing - -This is a guide for contributors. - -## Set up - -First, download the project - -```sh -go get github.com/dnote/dnote/cli -``` - -Go to the project root and download dependencies using [dep](https://github.com/golang/dep). - -```sh -dep ensure -``` - -## Test - -Run - -```sh -./scripts/test.sh -``` - -## Debug - -Run Dnote with `DNOTE_DEBUG=1` to print debugging statements. - -## Release - -* Build for all target platforms, tag, push tags -* Release on GitHub and [Dnote Homebrew tap](https://github.com/dnote/homebrew-dnote). - -```sh -VERSION=0.4.8 make release -``` - -* Build, without releasing, for all target platforms - -```sh -VERSION=0.4.8 make -``` - -**Note** - -- If a release is not stable, - - disable the homebrew release by commenting out `homebrew` block in `.goreleaser.yml` - - mark release as pre-release on GitHub release diff --git a/web/scripts/dev.sh b/web/scripts/dev.sh index 00c6d6e0..dd949dba 100755 --- a/web/scripts/dev.sh +++ b/web/scripts/dev.sh @@ -15,6 +15,7 @@ appPath="$basePath"/web PUBLIC_PATH="$appPath"/public \ STANDALONE=true \ COMPILED_PATH="$basePath/web/compiled" \ + IS_TEST=true \ "$appPath"/scripts/webpack-dev.sh ) & diff --git a/web/scripts/webpack-dev.sh b/web/scripts/webpack-dev.sh index dc61c52f..85181e04 100755 --- a/web/scripts/webpack-dev.sh +++ b/web/scripts/webpack-dev.sh @@ -14,6 +14,7 @@ appPath="$basePath"/web ASSET_BASE_URL=$ASSET_BASE_URL \ COMPILED_PATH=$COMPILED_PATH \ PUBLIC_PATH=$PUBLIC_PATH \ + IS_TEST=true \ "$appPath"/scripts/placeholder.sh && "$appPath"/node_modules/.bin/webpack-dev-server\ diff --git a/web/src/components/Icons/Logo.js b/web/src/components/Icons/Logo.js index 092b1e45..25bd396a 100644 --- a/web/src/components/Icons/Logo.js +++ b/web/src/components/Icons/Logo.js @@ -26,23 +26,21 @@ const Icon = ({ fill, width, height, className }) => { - - - + ); }; Icon.defaultProps = { - fill: '#000', + fill: '#2a2a2a', width: 32, height: 32 }; diff --git a/web/src/components/Icons/LogoWithText.js b/web/src/components/Icons/LogoWithText.js index 6101c0f8..747bd856 100644 --- a/web/src/components/Icons/LogoWithText.js +++ b/web/src/components/Icons/LogoWithText.js @@ -18,7 +18,7 @@ import React from 'react'; -const Icon = ({ className }) => { +const Icon = ({ className, fill }) => { return ( { > @@ -47,7 +47,7 @@ const Icon = ({ className }) => { }; Icon.defaultProps = { - fill: '#000', + fill: '#2a2a2a', width: 32, height: 32 }; diff --git a/web/src/components/Settings/Billing/PlanRow.js b/web/src/components/Settings/Billing/PlanRow.js index f0deb96f..d0f3191f 100644 --- a/web/src/components/Settings/Billing/PlanRow.js +++ b/web/src/components/Settings/Billing/PlanRow.js @@ -67,7 +67,10 @@ function PlanRow({ subscription }) {
{!subscription.id && ( - + Upgrade )} diff --git a/web/static/android-icon-144x144.png b/web/static/android-icon-144x144.png index 2de999fa..09b28d2f 100644 Binary files a/web/static/android-icon-144x144.png and b/web/static/android-icon-144x144.png differ diff --git a/web/static/android-icon-192x192.png b/web/static/android-icon-192x192.png index cc2147d8..48195236 100644 Binary files a/web/static/android-icon-192x192.png and b/web/static/android-icon-192x192.png differ diff --git a/web/static/android-icon-36x36.png b/web/static/android-icon-36x36.png index f7347b59..7c9f770f 100644 Binary files a/web/static/android-icon-36x36.png and b/web/static/android-icon-36x36.png differ diff --git a/web/static/android-icon-48x48.png b/web/static/android-icon-48x48.png index 59946a93..d93d8cda 100644 Binary files a/web/static/android-icon-48x48.png and b/web/static/android-icon-48x48.png differ diff --git a/web/static/android-icon-72x72.png b/web/static/android-icon-72x72.png index ed4b3193..aa2e9876 100644 Binary files a/web/static/android-icon-72x72.png and b/web/static/android-icon-72x72.png differ diff --git a/web/static/android-icon-96x96.png b/web/static/android-icon-96x96.png index 4093e8d8..6d711b98 100644 Binary files a/web/static/android-icon-96x96.png and b/web/static/android-icon-96x96.png differ diff --git a/web/static/apple-icon-114x114.png b/web/static/apple-icon-114x114.png index 890dd125..e6b7fece 100644 Binary files a/web/static/apple-icon-114x114.png and b/web/static/apple-icon-114x114.png differ diff --git a/web/static/apple-icon-120x120.png b/web/static/apple-icon-120x120.png index 3e2d5185..871eb9d0 100644 Binary files a/web/static/apple-icon-120x120.png and b/web/static/apple-icon-120x120.png differ diff --git a/web/static/apple-icon-144x144.png b/web/static/apple-icon-144x144.png index 2de999fa..09b28d2f 100644 Binary files a/web/static/apple-icon-144x144.png and b/web/static/apple-icon-144x144.png differ diff --git a/web/static/apple-icon-152x152.png b/web/static/apple-icon-152x152.png index 8caa91e1..16a2dd70 100644 Binary files a/web/static/apple-icon-152x152.png and b/web/static/apple-icon-152x152.png differ diff --git a/web/static/apple-icon-180x180.png b/web/static/apple-icon-180x180.png index c8e59aeb..77d31532 100644 Binary files a/web/static/apple-icon-180x180.png and b/web/static/apple-icon-180x180.png differ diff --git a/web/static/apple-icon-57x57.png b/web/static/apple-icon-57x57.png index 079bbd7b..ca17d420 100644 Binary files a/web/static/apple-icon-57x57.png and b/web/static/apple-icon-57x57.png differ diff --git a/web/static/apple-icon-60x60.png b/web/static/apple-icon-60x60.png index 79ce5712..9dbf917e 100644 Binary files a/web/static/apple-icon-60x60.png and b/web/static/apple-icon-60x60.png differ diff --git a/web/static/apple-icon-72x72.png b/web/static/apple-icon-72x72.png index ed4b3193..aa2e9876 100644 Binary files a/web/static/apple-icon-72x72.png and b/web/static/apple-icon-72x72.png differ diff --git a/web/static/apple-icon-76x76.png b/web/static/apple-icon-76x76.png index 271e2569..5e4af4bc 100644 Binary files a/web/static/apple-icon-76x76.png and b/web/static/apple-icon-76x76.png differ diff --git a/web/static/apple-icon-precomposed.png b/web/static/apple-icon-precomposed.png index a7a1dcd3..f3410b4e 100644 Binary files a/web/static/apple-icon-precomposed.png and b/web/static/apple-icon-precomposed.png differ diff --git a/web/static/apple-icon.png b/web/static/apple-icon.png index a7a1dcd3..f3410b4e 100644 Binary files a/web/static/apple-icon.png and b/web/static/apple-icon.png differ diff --git a/web/static/favicon-16x16.png b/web/static/favicon-16x16.png index ec833983..798fbd5c 100644 Binary files a/web/static/favicon-16x16.png and b/web/static/favicon-16x16.png differ diff --git a/web/static/favicon-32x32.png b/web/static/favicon-32x32.png index 5f72e7a9..a1be50c4 100644 Binary files a/web/static/favicon-32x32.png and b/web/static/favicon-32x32.png differ diff --git a/web/static/favicon-96x96.png b/web/static/favicon-96x96.png index 4093e8d8..6d711b98 100644 Binary files a/web/static/favicon-96x96.png and b/web/static/favicon-96x96.png differ diff --git a/web/static/favicon.ico b/web/static/favicon.ico index e826141e..c71572aa 100644 Binary files a/web/static/favicon.ico and b/web/static/favicon.ico differ diff --git a/web/static/ms-icon-144x144.png b/web/static/ms-icon-144x144.png index 2de999fa..09b28d2f 100644 Binary files a/web/static/ms-icon-144x144.png and b/web/static/ms-icon-144x144.png differ diff --git a/web/static/ms-icon-150x150.png b/web/static/ms-icon-150x150.png index ec94c736..0fa43061 100644 Binary files a/web/static/ms-icon-150x150.png and b/web/static/ms-icon-150x150.png differ diff --git a/web/static/ms-icon-310x310.png b/web/static/ms-icon-310x310.png index 5d978008..c8974c78 100644 Binary files a/web/static/ms-icon-310x310.png and b/web/static/ms-icon-310x310.png differ diff --git a/web/static/ms-icon-70x70.png b/web/static/ms-icon-70x70.png index c8c797b7..78fdbd5a 100644 Binary files a/web/static/ms-icon-70x70.png and b/web/static/ms-icon-70x70.png differ