Django Bucket List Repository

Welcome to the Django Bucket List repository! This project is a web application built with Django that allows users to create and manage their bucket list items. A bucket list is a collection of goals, dreams, and experiences that a person aspires to accomplish in their lifetime. With this application, users can add, edit, and track their bucket list items, making it easier to stay focused on their life's objectives.

Table of Contents

• Django Bucket List Repository
  • Table of Contents
  • Introduction
  • Features
  • Installation
  • Usage
  • Contributing

Introduction

The Django Bucket List project is designed to help users organize and prioritize their bucket list items effectively. Users can create an account, log in, and start adding their desired goals. Each item in the bucket list can have a title, description, target date, and status (e.g., in progress, completed). The application aims to provide a user-friendly interface and a seamless experience in managing one's bucket list.

Features

• User authentication: Users can create accounts and log in securely.
• Create and manage bucket list items: Users can add new items to their bucket list, edit existing ones, mark them as completed, or remove them if they change their mind.

Installation

To run this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/giovanibs/django_bucket_list.git

2. Change into the project directory:

   cd django_bucket_list

3. It is recommended to set up a virtual environment before installing the project dependencies. You can use venv for isntance:

   # Using venv (Python 3)
   python3 -m venv venv
   source venv/bin/activate

4. Install the required dependencies:

   pip install -r requirements.txt

5. Apply the database migrations:

   python manage.py migrate

6. Create a superuser account (an admin account) to manage the application:

   python manage.py createsuperuser

7. Finally, run the development server:

   python manage.py runserver

   ...or using gunicorn:

   gunicorn django_bucket_list.wsgi:application

The application will be accessible at http://localhost:8000/ in your web browser.

Usage

• Access the application by navigating to http://localhost:8000/ in your web browser.
• To start managing your bucket list, create a new account or log in if you already have one.
• Once logged in, you will be able to view your existing bucket list items or create new ones.
• Click on the add button to add a new goal to your bucket list.
• Edit or delete existing items by clicking on the respective options for each item.
• Mark items as completed when you achieve them.

Contributing

Contributions to this project are welcome and encouraged! If you want to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix: git checkout -b my-feature
3. Make changes and commit them: git commit -m "Add new feature"
4. Push to the branch: git push origin my-feature
5. Submit a pull request explaining your changes.

Please ensure your code follows the project's coding conventions and includes relevant tests.

---

I hope you enjoy using the Django Bucket List application! If you encounter any issues or have suggestions for improvement, please feel free to open an issue or submit a pull request. Happy bucket listing! 🚀