Readme of Project Twinkle

Twinkle Plan Readme

Twinkle

What is this?

A small paper/book reading (sharing) system, in which we could comment conveniently on each paper/book, even on some specific points, with some user-friendly technique support, such as @-user-support, math-support, paper-title-link-support, etc.

Besides, we also offer a feeds module to show what your friends are foucusing on, where you could easily make a discussion directly.

How to implement?

Boostrap + Python + Flask + MongoDB

Usage

Database

1. Install MongoDB
2. Create a folder for database storage

Python Package

1. pip install flask
2. pip install PyMongo
3. pip install Flask-PyMongo

Run

1. start MongoDB at the default port
   Windows (at the 'bin' folder of MongoDB): mongod --dbpath YourDBPath (replace 'YourDBPath' with your database storage path)
2. run command python run.py at the root folder

Modules

Login Module

• 1. Login, Logout
• 2. Database
• 3. Register
• 4. Secure Login (Flask-WTF)

Upload Module

• 1. Upload function & UI
• 2. Database (MongoDB save & load)
• 3. Matching text real-time when typing name/author/etc.

Comments Module

• 1. pdf.js(?) -- To be determined
• 2. the way of the Collection and Orgnization of all the comments (Database)
• 3. Some additive features, such as @-support, title-link-support, math-support, etc.

Feeds Module

• 1. Feeds (UI & Database of action recording)
• 2. Follow & Unfollow (UI & Database)

Technique TODO

• Flask-WTF (Secure Login)
• Set my MongoDB Key，not ObjectID generated automatically
• Create the database automatically
• Drag support when upload the file
• Progress Bar when upload the file:
  http://blog.163.com/liwei1987821@126/blog/static/172664928201531994270/
• TODO

Function Requirement

Comment

1. Comment可以选择不同类型，例如高亮，例如Question，例如Related，增加良好的Comment查询功能
2.

Ref

https://www.deepdyve.com/