Skip to content

Commit

Permalink
Added a README.md file (#1)
Browse files Browse the repository at this point in the history
* Update: Added a README>md file

* Update README.md
  • Loading branch information
ndongchrist authored Dec 1, 2023
1 parent 98adc20 commit 174b9b4
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ __pycache__/
*.py[cod]
*$py.class


#pipenv
Pipfile
Pipfile.lock


# C extensions
*.so

Expand Down
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]

0 comments on commit 174b9b4

Please sign in to comment.