From 94aac14d813f70a5b421234a1dd6f00a24e79d72 Mon Sep 17 00:00:00 2001
From: Felix Albrigtsen <felixalbrigtsen@gmail.com>
Date: Tue, 16 Aug 2022 22:13:48 +0200
Subject: [PATCH] Add readme and requirements

---
 README.md        | 40 ++++++++++++++++++++++++++++++++++++++++
 requirements.txt |  5 +++++
 2 files changed, 45 insertions(+)
 create mode 100644 README.md
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d92d4a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Worblehat
+## What?
+Worblehat is a simple library management system written specifically for Programvareverkstedet.
+
+## Why?
+Programvareverkstedet is a small community with many books and games. A simple web platform is needed to manage the library. We need to know who owns each item, if we can loan it out and where it is.
+
+## How?
+The entire application is written in flask. 
+
+Flask functions as a web server, and uses an ORM(SQLAlchemy) to store the data in an SQLite database.
+
+The resulting web page is rendered on the server by jinja templates in flask.
+
+
+# Technical Details
+## How to install
+
+* Make a `.env` file with a secret key.
+  * `$ echo "SECRET_KEY=<secret>" > .env`
+* Make a virtualenv
+  * `$ python3 -m venv venv`
+* Activate the virtualenv
+  * `$ source venv/bin/activate`
+* Install the requirements
+  * `$ pip install -r requirements.txt`
+
+## How to configure
+
+* Make changes in the function "`reset_db()`" in `worblehat/__init__.py` if needed
+* run `$ flask --app worblehat --debug resetdb`
+
+
+## Requirements
+### System / Package Manager
+* Python >= 3.6
+* Pip 
+
+### Python packages
+* See [requirements.txt](requirements.txt)
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..46385fd
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,5 @@
+Flask
+Flask-Admin
+Flask-SQLAlchemy
+click
+python-dotenv
\ No newline at end of file