Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 2.13 KB

README.md

File metadata and controls

39 lines (24 loc) · 2.13 KB
Raw

DoubleNote

This package is the all-features-included version of DoubleNote.

It combines the functionality of both the DoubleNote frontend, as well as the functionality of the DoubleNote backend.

It is possible to run the frontend as a stand-alone web-app using static serving (like a CDN).
The backend requires Node.js to work.

Usage

You can install DoubleNote globally, or run it using npx.

  1. Run DoubleNote using npx
    1. Install npx (if you haven't done so already) with npm i npx -g
    2. Start DoubleNote using npx doublenote
  2. Install DoubleNote globally using npm
    1. Run npm i doublenote -g to install DoubleNote globally
    2. Start DoubleNote using dn or doublenote

This application is also available as a Docker image at https://hub.docker.com/r/berndl/doublenote.

Further reading

For information about the frontend, see the frontend README.md.
For information about the backend, see the backend README.md.
For information about the application as a whole, see the main README.md.

Licence & Copyright

Copyright (c) 2020 Bernd-L. All rights reserved.

DoubleNote is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

DoubleNote is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with DoubleNote. If not, see https://www.gnu.org/licenses/.

This project (including its source code and its documentation) is released under the terms of the GNU Affero General Public License.