Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cknoll/simplefeedback

Experimental web application to collect comments on a text from various reviewers
https://github.com/cknoll/simplefeedback

Last synced: about 20 hours ago
JSON representation

Experimental web application to collect comments on a text from various reviewers

Host: GitHub
URL: https://github.com/cknoll/simplefeedback
Owner: cknoll
License: gpl-3.0
Created: 2024-04-21T13:56:15.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-04-21T13:57:01.000Z (7 months ago)
Last Synced: 2024-10-13T11:31:04.386Z (about 1 month ago)
Language: Python
Size: 636 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # SimpleFeedback

Experimental code, based on  and ["Django REST Framework Oversimplified"]([https://www.youtube.com/watch?v=cJveiktaOSQ).

The goals is the following:

## Idea Description

- The user (A) can submit a text in markdown.

- The user (A) receives 2 URLS:

    - easyfeedback.net/\-\

    - easyfeedback.net/\-\

- The user (A) can share the second URL to user (B), user (C) etc.

- User (B) can open easyfeedback.net/\-\ and

    - read the text,

    - make annotations,

    - enter a name (e.g. "user (B)"),

    - solve a captcha (maybe optional).

    - upload the annotation data as "a review".

- User (C) etc can do the same. They do not see the annotations of other users.

- User (A) can then open easyfeedback.net/\-\ and

    - see that two reviews were uploaded,

    - display each review individually,

    - jointly display selected reviews (e.g. to see where multiple people had comments).

## Notes for Local Testing

### Manual Testing

- `rm -f db.sqlite3; python manage.py migrate --run-syncdb; python manage.py loaddata base/testdata/fixtures01.json`

- `python manage.py runserver`

Store test-data:

- `python3 manage.py dumpdata | jsonlint -f > tmp.json`

### Unittests

`pytest` (require splinter installed and configured)

### Feedback

Contact me