From 174b9b40d17c69b6905872b8677718ab15c0a207 Mon Sep 17 00:00:00 2001
From: Ndongmo Christian <94064299+ndongchrist@users.noreply.github.com>
Date: Fri, 1 Dec 2023 12:25:01 +0100
Subject: [PATCH] Added a README.md file (#1)

* Update: Added a README>md file

* Update README.md
---
 .gitignore |  6 ++++++
 README.md  | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index afcc566..fb95459 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,12 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+
+#pipenv 
+Pipfile
+Pipfile.lock
+
+
 # C extensions
 *.so
 
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a59abab
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Django Todo App
+
+This is a simple Django todo app to manage your tasks.
+
+
+## Description
+This project was build during an a workshop. The title of the workshop was "Building a Django App and Deploying it on Azure" -  so you can check a working version of this app here [link](https://dj-cmr-todo.azurewebsites.net/)
+
+if you want to learn how to deploy a web app on azure you can [follow](https://learn.microsoft.com/en-us/training/modules/host-a-web-app-with-azure-app-service/) this steps.
+
+
+## Getting Started
+
+1. Clone the repository:
+
+   ```bash
+   https://github.com/djangocameroon/djangotodoazure.git
+   cd django-todo-app
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. Apply database migrations:
+
+   ```bash
+   python manage.py migrate
+   ```
+
+4. Run the development server:
+
+   ```bash
+   python manage.py runserver
+   ```
+
+## Usage
+
+Visit http://localhost:8000 in your browser to access the todo app.
+
+## Contributing
+
+We welcome contributions! Please follow these guidelines:
+
+- Fork the repository.
+- Create a new branch: `git checkout -b feature-name`.
+- Make your changes and commit them: `git commit -m 'Add new feature'`.
+- Push to the branch: `git push origin feature-name`.
+- Submit a pull request.
+
+## Contact
+
+If you have any questions or concerns, please open an issue or contact us at yokwejuste@gmail.com
+