This project was spawned from the requirement for a to do list application that did not connect to any external services and upload the contents of the list. By utilising the browsers local storage to store the list in a json format that javascript code has access to it feels like a 'online' application. Inspiration for the theming of the application is taken from Trello.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
If you just want to use the application the easiest way is to go to the github pages link to this repository.
This application is currently built using the following:
- Windows 10 PC (10.0.17134)
- Atom
- Prepros
The only requirement is that Prepros is installed. The Prepros config file is included in the repository when you clone. There are two folder that are important.
- /dist
- /src
Files that Prepros interacts with are located in the /src directory, any other files are located in the /dist folder. An example is index.html, this lives in /dist as Prepros does not compile it. For styling edit the files contained within /src/scss/. For script changes edit the files contained within /src/js/.
The /dist folder contains everything that you require for deployment. Just put the files onto a web server or just a folder and run index.html.
- Atom (1.36.0) - IDE
- Visual Studio Code (1.33.1) - IDE
- Prepros (6.3.0) - Used to compile SCSS and JS
- jQuery (3.4.0) - JS Library
- Autosize (4.0.2) - Textarea resize JS library
- Font Awesome (5.8.1) - Icon Library
- tail.DateTime (0.4.9) - Date Picker JS Library
- Marked (0.6.2) - Markdown to HTML Converter
- hightlight.js (9.15.6) - Markdown Code Highlighter
This project is licensed under the MIT License - see the LICENSE.md file for details.
We use SemVer for versioning.