Add comprehensive README documentation for django-nextjs-auth

[Copilot]

Overview

This PR adds comprehensive documentation to the repository by creating a detailed README.md file that provides complete guidance on setting up, configuring, and using the Django-Next.js authentication system.

What's Changed

The previous README contained only a brief title and one-line description. This has been replaced with a comprehensive 293-line documentation that covers all aspects of the project.

Documentation Includes

🎯 Core Information

• Project overview with clear description of the authentication implementation
• Features list highlighting 8 key capabilities (user authentication, session management, token-based auth, protected routes, CORS configuration, modern UI, and type safety)
• Complete tech stack details for both backend (Django 4.2.6, DRF, django-allauth, django-cors-headers) and frontend (Next.js 14.0.0, NextAuth.js, TypeScript, Tailwind CSS)

🚀 Setup & Installation

• Prerequisites section listing required software and versions
• Step-by-step backend setup including:
  • Python virtual environment creation
  • Dependencies installation
  • Environment variables configuration with secure secret key generation
  • Database migrations
  • Superuser creation
  • Development server launch
• Step-by-step frontend setup including:
  • Node dependencies installation
  • NextAuth configuration
  • Environment variables setup with security best practices
  • Development server launch

📚 Reference Documentation

• Project structure with visual directory tree
• API endpoints documentation listing all authentication routes
• Authentication flow explanation
• Customization guide for extending the user model and styling
• Testing instructions for both backend and frontend
• Deployment guidelines with production security considerations

🤝 Community

• Contributing guidelines with standard GitHub workflow
• License information (Apache 2.0)
• Acknowledgments and support contact information

Benefits

This documentation will help:

• New users quickly understand what the project does
• Developers get up and running with clear installation steps
• Contributors understand the project structure and how to contribute
• Users properly configure environment variables and security settings
• Teams deploy the application to production safely

Fixes

Closes the documentation issue by providing the proper documentation requested for the repository.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Provide documentation</issue_title>
<issue_description>Need to ship a proper documentation on how to use this repository.</issue_description>

<agent_instructions>create README file</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #4

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[Copilot]

Copilot wasn't able to review any files in this pull request.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}