404pandas/pwa-kitties

PWA app with jate starter code

K.I.T.T.I.E.S.

Kitten Impregnable Thoughts Text In-Line Editing Software
Explore the docs »

View App · Report Bug · Request Feature

Table of Contents

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

About The Project

This project was built using Webpack, Babel, and CodeMirror to create a progressive web app text editor themed around cats

Built With

Getting Started

This app is fully functional and live at: https://pwa-kitties.onrender.com/

If you would like to run the app locally, follow the below installation instructions

Installation

1. Clone the repo git clone https://github.com/404pandas/pwa-kitties.git

Usage

Please enjoy this video of the application being used

(in development)

To run in the app locally, simply run npm i to install all the dependencies.

Then, run npm run start to launch the application

To install the application while it's running locally, open the application at https://localhost:3000 and click on the install button

Follow the prompts to complete the installation to operate this app offline!

Roadmap

MVP

• Starter Code added
• indexDB functionality
• Webpack functionality
• Service Worker functionality
• manifest.json created w/ npm run build
• Install button functionality
• Deployed

Future Development

• Add front end

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

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

License

This project is licensed under the MIT license.

See LICENSE.txt for more information.

Contact

Mary Elenius - mary.panda.jackson@gmail.com

Repo Link: https://github.com/404pandas/pwa-kitties Live Link: https://pwa-kitties.onrender.com/

Acknowledgments

I would like to give a big shoutout to my partner in crime and daughter, Yennefer! Every day she proves she is small yet mighty!