Jotrift

An open-source recursive note taking application built with TypeScript, React, Sass, & Jest

TODO: description here

Technologies Overview

Directory Overview

To use this application, visit [https://jotrift.com].

To install this project

Install Node
Clone this repository to your computer.
Open a terminal in the root directory.
Run npm i in the terminal.

From here, you may run npm run start:stage and open the application in a browser at localhost:1111.

Scripts

To run a script, type npm run <script-name>

script-name	description
`build`	call build:dev
`build:dev`	try to compile the application into /bin/
`build:stage`	try to compile an optimized version of the app into /bin/ with dev tools enabled
`build:prod`	try to compile an optimized version of the application into /bin/
`start`	call start:dev
`start:dev`	build:dev & start a hot-reloading dev server at localhost:1000
`start:stage`	build:stage & start a hot-reloading dev server at localhost:1111
`start:prod`	build:prod & start the npm server
`test`	run all Jest unit tests and produce a coverage report
`test:watch`	test & rerun when files are updated

To contribute to this project

Unfortunately, this template doesn't support user contributions right now.

TODO:

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

    This program 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.

    This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.

You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see https://www.gnu.org/licenses/.