Skip to content

Commit

Permalink
update readme and add screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Kenan7 committed Feb 10, 2021
1 parent ea641e1 commit 9817108
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 90 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Labrin Task Project

## User files page
![img](./screenshots/Screenshot_155.png)

## file owner perspective
![img](./screenshots/Screenshot_156.png)

## adding the user with viewer and commenter role
![img](./screenshots/Screenshot_157.png)

## added
![img](./screenshots/Screenshot_158.png)

## comment log
![img](./screenshots/Screenshot_159.png)

## other user perspective for file detail page
![img](./screenshots/Screenshot_160.png)

## we are deleting the users' commenter role
## and the user neither can see nor submit any comment
## it is also restricted in backend [consumer.py](https://github.com/Kenan7/labrin-task/blob/main/labrin_task/chat/consumer.py)
![img](./screenshots/Screenshot_161.png)
107 changes: 17 additions & 90 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,97 +1,24 @@
My Awesome Project
==================
# Labrin Task Project

Behold My Awesome Project!
## User files page
![img](./screenshots/Screenshot_155.png)

.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter
:target: https://github.com/pydanny/cookiecutter-django/
:alt: Built with Cookiecutter Django
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
:alt: Black code style
## file owner perspective
![img](./screenshots/Screenshot_156.png)

## adding the user with viewer and commenter role
![img](./screenshots/Screenshot_157.png)

:License: MIT


Settings
--------

Moved to settings_.

.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html

Basic Commands
--------------

Setting Up Your Users
^^^^^^^^^^^^^^^^^^^^^

* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

* To create an **superuser account**, use this command::

$ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks
^^^^^^^^^^^

Running type checks with mypy:

::

$ mypy labrin_task

Test coverage
^^^^^^^^^^^^^

To run the tests, check your test coverage, and generate an HTML coverage report::

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with py.test
~~~~~~~~~~~~~~~~~~~~~~~~~~

::

$ pytest

Live reloading and Sass CSS compilation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Moved to `Live reloading and SASS compilation`_.

.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html



Celery
^^^^^^

This app comes with Celery.

To run a celery worker:

.. code-block:: bash
cd labrin_task
celery -A config.celery_app worker -l info
Please note: For Celery's import magic to work, it is important *where* the celery commands are run. If you are in the same folder with *manage.py*, you should be right.





Deployment
----------

The following details how to deploy this application.

## added
![img](./screenshots/Screenshot_158.png)

## comment log
![img](./screenshots/Screenshot_159.png)

## other user perspective for file detail page
![img](./screenshots/Screenshot_160.png)

## we are deleting the users' commenter role
## and the user neither can see nor submit any comment
## it is also restricted in backend [consumer.py](https://github.com/Kenan7/labrin-task/blob/main/labrin_task/chat/consumer.py)
![img](./screenshots/Screenshot_161.png)
Binary file added screenshots/Screenshot_155.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/Screenshot_156.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/Screenshot_157.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/Screenshot_158.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/Screenshot_159.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/Screenshot_160.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/Screenshot_161.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9817108

Please sign in to comment.