diff --git a/README.md b/README.md index f276815..503dbf5 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,32 @@ This is a simple **Flask CRUD (Create, Read, Update, Delete) application** that uses **SQLite3** as the database. It allows users to add, edit, delete, and view user records. It has been modified by us for the purposes of the course. The original repo can be found [here](https://github.com/iamsamimsarkar/flask-crud-sqlite) + +## Local installation instructions + +1. **Clone the Repository** + +2. **Create a Virtual Environment (Optional but Recommended)** + ```bash + python -m venv venv + source venv/bin/activate + ``` + +3. **Install Dependencies** + ```bash + pip install -r requirements.txt + ``` + +4. **Run the Application** + ```bash + python app.py + ``` + +5. **Open in Browser** + Open `http://127.0.0.1:5000/` in your browser. + +## Information for teaching staff + +The report for our project can be found here in the root folder of the repo as "Report.pdf". + +The webpage hosting our deployed version of the application can be found [here](https://devops-app-2ldrlwtrxq-lz.a.run.app/) diff --git a/Report.pdf b/Report.pdf new file mode 100644 index 0000000..0d68b78 Binary files /dev/null and b/Report.pdf differ