quark-text-editor's Introduction

Quark-Text-editor

This app is a simple re-make of atom. Atom is a text editor which has been built specifically for writing code.

This was a 2 week final project by abitravers89, david-div, FreddieCodes and puyanwei

Installation

Open command line.
Clone this repository by typing: git clone https://github.com/FreddieCodes/Quark-Text-editor
Go to the root folder of the project and npm install to install all the relevant dependancies.
Depending on your operating system, create a copy of the the app by running the following:
npm run package-mac
npm run package-win
npm run package-linux
The app will then be located in: release-builds/Quark-darwin-x64/

Testing

Navigate to the root folder of this repo in your command line.
Type in npm test.

## MVP User Stories

As a user of Quark Text Editor,
I would like to be able to open the programme.

As a user of Quark Text Editor,
I would like to be able to add some text.

Extra Features User Stories

As a user of Quark Text Editor,
I would like to write text and have it automatically formatted into code live.

As a user of Quark Text Editor,
I would like to be able to save my code on my local machine.

As a user of Quark Text Editor,
I would like to be able to load my files and have its coding language be automatically recognised and formatted appropriately.

As a user of Quark Text Editor,
I would like to be able to edit my saved files.

As a user of Quark Text Editor,
I would like to be able to delete my saved files.

As a user of Quark Text Editor,
I would like to see character, word and line counts shown updated live as I type.

As a user of Quark Text Editor,
I would like to see my root folders be displayed when pressing a button.