Textable

Showcases the authors completed projects, experiences, skills and contact details.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

As a Developer of a Progressive Web Application, I would like to create a text editing webapp for programmers and coders to write or insert their code. This will allow the user to save the code and come back to it later on with the feature of working offline without an internet connection.

Mock Up

The following animation demonstrates the application functionality:

The following image shows the application's manifest.json file:

The following image shows the application's registered service worker:

The following image shows the application's IndexedDB storage:

(back to top)

Built With

• Express
• Node
• Webpack

(back to top)

Getting Started

Clone the repository and install the npm packages

Prerequisites

None at this stage

Installation

1. Clone the repo

   git clone https://github.com/gurtej154/Textable-project.git

2. Install NPM packages

   npm install

(back to top)

Usage

To ulitise this application, the following need to be installed and implemented in the command line.

• Npm init - for node packages
• Npm install - for multiple packages

(back to top)

Roadmap

• Constantly updating to current standards

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Gurtej Singh - gurtej154

Project Link: Repository

(back to top)

Acknowledgments

• N/A

(back to top)