Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

ychalier/orgapy

Repository files navigation

Orgapy

A personnal notebook webapp.

Getting Started

Prerequisites

You'll need Python 3, and a Django project.

Installation

  1. Install the latest release

    pip install django-orgapy-X.X.X.tar.gz
  2. Add "orgapy" to the INSTALLED_APPS variables in Django settings

  3. Migrate the database

    python manage.py migrate
  4. Collect new static files

    python manage.py collectstatic
  5. Setup URLs

    from django.urls import include
    import orgapy.urls
    urlpatterns = [
    path("orgapy/", include("orgapy.urls", namespace="orgapy")),
    ]
  6. Restart the server

Description

Main Features

  • Write notes in Markdown
  • Track current projects
  • Track current tasks
  • Track regular habits
  • Integrate events from a CalDAV server
  • Edit spreadsheets (stored as TSV)
  • Edit maps (stored as GeoJSON)

Permissions

The app uses Django built-in authentication framework, meaning that users need a Django account to created and edit notes. They also need to be granted Orgapy's permissions, such as orgapy.add_note or orgapy.view_note.

Built With

  • caldav - A CalDAV client library for Python.
  • dateutil - Useful extensions to the standard Python datetime features.
  • Django - Web application framework for Python.
  • Fira Code - Monospace font.
  • Fira Sans - Sans serif font.
  • highlight.js - Syntax highlighter.
  • Leaflet - An open-source JavaScript library for mobile-friendly interactive maps.
  • Remix Icon - An open source icon library.
  • Showdown - A JavaScript library for parsing Markdown.
  • Showdown KaTeX - Showdown extension to render math.
  • SimpleMDE - A simple, embeddable, and beautiful JS markdown editor.
  • sql.js - A JavaScript library to run SQLite on the web.
  • zip.js - A JavaScript library to zip and unzip files.

Artworks:

Contributing

Contributions are welcomed. Push your branch and create a pull request detailling your changes.

Authors

Project is maintained by Yohan Chalier.

License

This project is licensed under the GNU GPLv3 license.