J.A.T.E. - Just Another Text Editor

Description

This application takes an existing text editor app and adds functionality for it to work as a PWA and function offline. This application is deployed through Heroku.

Table of Contents

• Description
• Table of Contents
• Installation
• Usage
• Deployed Link
• Demo
• Built With
• License
• Contributing
• Tests
• Questions

Installation

git clone the repo to your local machine. To use this application, run the following command to install the dependencies:

 npm install

Then run the following command:

npm run start:dev

Usage

Type the following command in your termimal:

npm run start

Then open Insomnia and type http://localhost:3000/ to run this application on your local machine.

Deployed Link

The link to the deployed application is: https://jate-bfguo.herokuapp.com/.

Demo

Below is the demostration of this application. Please click here for walk-through video.

⬆ back to top

Built With

• HTML
• CSS
• Javascript
• NodeJS
• ExpressJS

⬆ back to top

License

This application is licensed under MIT license.

⬆ back to top

Contributing

This application is developed by Baofeng Guo. If you would like to contribute it, please follow the guidelines for how to do so.

⬆ back to top

Tests

To run tests on the application, run

npm install jest

and then npm run test from the command line.

⬆ back to top

Questions

For any question, please contact me on GitHub: magickw or email me at peterguo1983@gmail.com.

⬆ back to top