aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 779614192bb8ea135268f92780ce56a6307d9ed6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# Project purpose

Create, edit and view notes

The concept of snoozing a note. DeQuincy via Manly P Hall: after weeping in the British museum over the fact that one cannot possibly read all the books contained in the libraries, DeQuincy said, "as I cannot read all these books, I will read only the best". Sometimes you take notes that end up not being useful to you, you can snooze these notes, surface them later, reflect on them a second time and then decide, is this something I want to keep around, is it something that has knowledge I need or is it something I should let go of and move on to something else?

## Internal Apps
### Accounts
* [User](https://git.luxagraf.net/luxagraf/writer/src/branch/master/apps/accounts/models.py)
    * custom User model subclassing AbstractUser as per [Django best practices](https://docs.djangoproject.com/en/dev/topics/auth/customizing/#using-a-custom-user-model-when-starting-a-project)
* [UserProfile](https://git.luxagraf.net/luxagraf/writer/src/branch/master/apps/accounts/models.py)
    * adds profile to the user class with:
        * profile photo
        * website 
        * bio
        * location


## External dependencies 

#### [Coverage](https://github.com/nedbat/coveragepy)
* Because I hate keeping track of what needs tests

#### [Python Decouple](https://pypi.org/project/python-decouple/)
* Decouple helps you to organize your settings so that you can change parameters without having to redeploy your app.
* Allows committing settings.py by keeping not-committed settings in one place (.env)

#### [Django Taggit](https://github.com/alex/django-taggit)
* Simplest way to get robust tagging capabilities

#### [Django Storages](https://github.com/jschneier/django-storages)
* Simplest way to make all static assets go to Amazon S3 
* Simplifies migrating server setups by keep static assets off the server

#### [Django Registration](https://github.com/ubernostrum/django-registration/)
* Simplest way to handle all aspects of registration/confirmation (written by James Bennett)

#### [Django Pwned Passwords](https://github.com/ubernostrum/pwned-passwords-django)
* Because we should inform people when their passwords are compromised (written by James Bennett)

#### [Django-Extensions](https://github.com/django-extensions/django-extensions)
* Because I'd go crazy without it. shell_plus is a godsend

## Art credits
<div>Icons made by <a href="https://www.freepik.com/" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" 			    title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" 			    title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></div>

## Features

### Capture

### Editing

### Organizing

### Surfacing

### Outlining

### Archiving

### Versioning

### Collaborating