README.md

No longer in development!

pytatki

Pytatki is an open source web app for storing notes and learning resources. The purpose of this app is to make organizing them easier and faster.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Instalation

Clone this repo

git clone https://github.com/PRD-ev/pytatki.git

Install Flask dependencies

pip install -r requirements/common.txt

Install React dependencies

yarn add

Build bundles

yarn run build

Configuration

Create config.json file in root directory of repository. You can find an example in examples folder.

{
  "default": {
    "secret_key": "change_it",
    "debug": true,
    "host": "127.0.0.1",
    "port": 5000
  },
  "email": {
    "mail_server": "smtp.gmail.com",
    "mail_port": 587,
    "mail_use_ssl": false,
    "mail_use_tls": true,
    "email": "[email protected]",
    "email_password": "your_password"
  },
  "database": {
    "db_host": "127.0.0.1",
    "db_user": "pytatki",
    "db_password": "pytatki",
    "db_name": "pytatki"
  }
}

To configure database run init_db.py script.

Testing

pytest
jest

Built With

• Bootstrap
• Flask
• React

Contributing 🎉

Feel free to contribute 😜. If you want to contact owners: CONTRIBUTING.md

Authors

• Patryk Niedźwiedziński - Initial work - butterfly-pn
• Filip Wachowiak - React developer - filipw01

Check out contributors

TODO

• Add new note (tags, notegroup etc.)
• Login, register + admin
• Search
• Manage note (delete, hide, properties etc.)
• Usergroups