The 3rstore from tsimpdim

3rstore's Introduction

An application for storing and managing links online.

Status

This application is currently available here

Running it locally

Ooh boy here we go.

First of all you need Python 3.x Then, go ahead and install PIP. Instructions for its installation are available here

To make sure all the depedencies are installed run:

pip install -r requirements.txt

Next, you must have a PostgreSQL database created. For that you can use PG Admin.

You will then have to create a config.json file which has the following structure:

{
    "DB":{
        "USER": <DB_USER>,
        "PWD": <DB_PASSWORD>,
        "HOST": <DB_HOST>,
        "DATABASE": <DB_NAME>,
        "PORT": <DB_PORT>
    },
    "SECRET_KEY": <your_scecret_key>,
    "MAIL_SERVER":"smtp.gmail.com",
    "MAIL_PORT":465,
    "MAIL_USE_TLS":false,
    "MAIL_USE_SSL":true,
    "MAIL_USERNAME": <EM_USER>,
    "MAIL_PASSWORD": <EM_PASSWORD>,
    "MAIL_DEFAULT_SENDER": <EM_USER>
}

The MAIL settings/fields are necessary for the password recovery process, if you don't plant on using the feature you can remove them.
The specified MAIL_SERVER and MAIL_PORT are for use with a GMAIL address.
The MAIL_DEFAULT_SENDER property can be removed but then you will have to specify the sender when building a Message

Since the project's file structure has changed, a simple

python __init__.py

will not suffice.

Running the app with docker-compose

It's heavily encouraged to run the project locally using docker-compose. Simply running docker-compose up should suffice. Afterwards, you should be able to access the site on localhost:5000.

Running the app with flask

First you need to set the environment variable for the application.

One way to do this is :

From /3RStore

On linux:

export FLASK_APP=_3RStore/__init__.py

On windows:

set FLASK_APP=_3RStore/__init__.py

Then (from this directory) simply run :

flask run

to launch the server. A prompt indicating sucessfull launch should appear in the console.

If you want to set Flask's debug mode on you can use:

export FLASK_DEBUG=true

And

set FLASK_DEBUG=true

For Linux and Windows respectively.

Finally, you can open your browser and go to

http://127.0.0.1:5000/

If you get an error regarding the build environment, set/export the FLAK_ENV variable to whatever you please

Running the app with waitress

First run

python server.py

Then go to

http://127.0.0.1:8080/

Ta-da!

3rstore's People

Contributors

Stargazers

Watchers

3rstore's Issues

Automatic tags when importing

Since you can organize your bookmarks into folders, it would be great if the names of the folders were represented as tags.

Allow newlines in the Note field

As of right now entering a newline/linebreak is not possible :{

Decode URLs from UTF-8 when adding/editing/importing a resource

For example the following link:

http://www.ba.teiwest.gr/pages/statistiki/%CE%A3%CE%A5%CE%9D%CE%9F%CE%9B%CE%99%CE%9A%CE%95%CE%A3%20%CE%A3%CE%A5%CE%9D%CE%9F%CE%A0%CE%A4%CE%99%CE%9A%CE%95%CE%A3%20%CE%A3%CE%97%CE%9C%CE%95%CE%99%CE%A9%CE%A3%CE%95%CE%99%CE%A3%20%CE%A3%CE%A4%CE%91%CE%A4%CE%99%CE%A3%CE%A4%CE%99%CE%9A%CE%97%CE%A3.pdf

should be shown as:

http://www.ba.teiwest.gr/pages/statistiki/ΣΥΝΟΛΙΚΕΣ%20ΣΥΝΟΠΤΙΚΕΣ%20ΣΗΜΕΙΩΣΕΙΣ%20ΣΤΑΤΙΣΤΙΚΗΣ.pdf

To do this we can use urlib.parse.unquote

Improve styling in the registration forms warnings

Improve the look of the "Filtered Delete" and "Remove Tags" options

Instead of having the button above the input field it would look better next to it

Better handling of resource deletion

Right now one can easily delete a resource by accident and there's no way he can recover it.

A confirmation of sorts must definitely be put in place and a way to recover deleted resources would be a great addition

Persistent sessions

When a user first logins we can create a unique session_id and store that in the db with his username and as a cookie.

Then we can use this decorator to check if the user has logged in before from this device (by checking if a cookie with a session_id exists and grabbing his info from the db).

Show/Suggest tags based on pre existing ones

Remove tag entirely

Perhaps it would be useful for a user to remove a tag from every resource.

Although removing values from pg arrays might seem problematic/difficult, since we are using pg 10+ we could use this

Delete account button

Would be nice to have an option to fully delete one's account

An option for the ordering (ASC/DESC)

'About' view does not exist yet is still in the code

Not sure how i forgot to delete it

resources_cmpct.css interferes with the links in the home page

Tags should not be case sensitive

As of now, you can have a tag be "tag1" and another be "Tag1". They should probably be transformed into all lowercase

Filtered delete

For example "Delete only resources with x tag"

Navbar disappears when scaling window down

It has something to do with the collapse class i have used, i'm looking into it

Live version of the app has old version of options.css

Some options should be in a different view

Say, the export button (if it ever gets implemented), the delete all button and the sorting button

Export button
Delete all button
Sorting button

Filtered delete does not fit in mobile screen

Kinda maybe should've made it responsive

When editing a resource no messages appear

If for example you don't enter a title, what should happen is a little message appears saying that you need to fill the field. But nothing appears, instead you are redirected to /resources

An export button

Since we can import, it'd be nice to be able to export too...just in case.

Pagination in the resources page?

Redirect to HTTPS

Heroku enables https by default (see : https://threerstore.herokuapp.com) however, the views redirect users to http(?)

(e.g Follow the above link and then hit logout/login, you should now be at an HTTP version of the site :/ )

Increase threshold for collapsing notes

100 characters can easily fit inside the card footer, we could go with 200 or even 300 chars before collapsing the notes.

UTF8 decoding on import

Fix UTF-8 decoding when importing resources. Currently UTF-8 decoding exists only when adding resources manually.

To decode we use parse.unquote(<link>)

Show number of resources saved

I think a good place for this indicator would be next to the username

Perhaps the delall route should be accessed through a POST request, so as to make it more secure

Forgot password process

Perhaps it is far fetched / useless for such a small scale app but it would be nice to learn how to implement such a process

Search doesn't work in Compact view

Add ability to remove unwanted tags from search.

If for example I have some resources with the tags books, books read and others with the tag books right now if I search for books I will get both. But what if I only want the ones without the books read tag?

Set up Docker

You can have multiple users with the same username & email combination

So you can have for example the following:

email	username
[email protected]	OneTwo
[email protected]	OneTwo
[email protected]	OneTwo2
[email protected]	OneTwo

As you can imagine this produces a bit of a problem :)

'Delete All Resources' does not push the resources into the trash bin

Which it should. Same as the 'Filtered Delete' functionality.

Error 500 when exporting resources

File "/app/_3RStore/views.py", line 628, in export_to_html
root_folder_exists = soup.find('H3', string=tag_array[i-1][0])
IndexError: tuple index out of range

Migrate to Bootstrap v4.1

You can check the commits in the Migrate-Bootstrap-v4.1 branch

_navbar
resources
options

Include / Exclude certain folders on Import

Since you can't choose which bookmarks to export (on Chrome at least) it would be nice if we could filter them during importing

Allow for a more compact view

Either in the options or in the resources page there should be icons/buttons to change the view to either be compact or normal

Secure cookies with the appropriate flags

Rework the file structure to match Flask's example

A delete all button

Title. This could be expanded to be a "Delete all resources with tag x" button.

Error 500 when editing a resource without a note

`File "C:\Users\Home\Desktop\Misc\Dim\3RStore_3RStore\views.py", line 347, in edit_res

form.note.data = data[0]['note'].replace('</br>','\n') # Else the
tags will display as text `

AttributeError: 'NoneType' object has no attribute 'replace'

</br> tags don't seem to be removed when you edit a resource

The culprit is probably either not using the safe flag on Jinja or these lines

Minor changes

Change the header color on mobile browsers (right now it is a shade of blue)
Remove the focus borders from the buttons (namely the header buttons and the burger menu)
Fix/Improve the two 'delete resources' options being too close to one another in small screens
Add a small bottom margin in the resource container when using the compact view

tsimpdim / 3rstore Goto Github PK