Code Monkey home page Code Monkey logo

nuggets's Introduction

Nuggets

A Flask/MongoDB application that stores small bits of information (nuggets) organized by keywords.

Nuggets was created to serve as a lightweight application that you can use to store information that you need to remember. Code samples, infrastructure details, to-do lists, etc.

Requirements

I promise I will get all of this into a setup file soon. For now, you're going to need the following dependencies installed:

  • Flask
  • Flask_WTF
  • MongoDB
  • Flask_PyMongo

Running Nuggets

  • Start up mongo in a terminal using the command: mongo
  • Start the Nuggets Flask application in another terminal using the command: FLASK_APP=nuggets FLASK_DEBUG=True flask run --port=5050
  • Once running, open a browser window and navigate to: http://localhost:5050
  • Have fun!

Usage

Nuggets is quite straightforward. Use the Create Nugget link in the header when you want to add a new piece of information. The Description field uses standard Markdown syntax. The only "gotcha" is related to code syntax and highlighting. In order to get true code output, I suggest you manually use the <pre><code>xxx</code></pre> syntax instead of the three-backtick approach. This is due to a quirk with markdown/HTML rendering, and allows Nuggets to benefit from use of the highlight.js <https://highlightjs.org> code formatting library.

I also included a Random link in the header, just for the heck of it. Click on the link and it will return an random Nugget.

nuggets-001.png

nuggets-002.png

TODO

  • Pagination to all results lists
  • init cleanup
  • backup MongoDB
  • Start script that will auto-start MongoDB and the Flask application
  • Delete a Nugget via Javascript "confirm" action
  • Submit to PyPI?

nuggets's People

Contributors

yoshizzle avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.