Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 1.98 KB

README.md

File metadata and controls

81 lines (53 loc) · 1.98 KB

Sure! Here's an example of a GitHub readme for the repository "Django-Blog" by mohamadanasfattoum:

# Django-Blog

This is a simple Django blog application that allows users to perform full CRUD (Create, Read, Update, Delete) operations using both Function-Based Views (FBV) and Class-Based Views (CBV).

## Tech Stack

The project is built using the following technologies:

- Python
- Django
- Bootstrap 4
- Summernote (rich text editor)
- django-cbv (Django Class-Based Views)
- taggit (tagging system)

## How to Run

To run the Django-Blog application locally, please follow these steps:

1. Clone the repository to your local machine using the following command:

git clone https://github.com/mohamadanasfattoum/Django-Blog.git


2. Navigate to the project directory:

cd Django-Blog


3. Create a virtual environment and activate it (optional but recommended):

python -m venv venv source venv/bin/activate


4. Install the project dependencies:

pip install -r requirements.txt


5. Apply the database migrations:

python manage.py migrate


6. Create a superuser (admin) account:

python manage.py createsuperuser


Follow the prompts to enter your desired username and password.

7. Start the development server:

python manage.py runserver


8. Open your web browser and access the application at [http://localhost:8000](http://localhost:8000).

9. To access the admin dashboard, go to [http://localhost:8000/admin](http://localhost:8000/admin) and login with your superuser account.

That's it! You should now have the Django-Blog application up and running on your local machine.

## License

This project is licensed under the [MIT License](LICENSE).

Please note that this readme assumes the project structure and setup are consistent with a typical Django project.

project screenshot