platform-users 1.0.5

This is an app for managing users in a SaaS product named Platform.

# platform-users: Django Authentication Module

platform-users is a comprehensive Django authentication module designed to streamline user authentication in your projects. It offers a range of features, including a customizable user model, JWT-based authentication, and easy integration.

Table of Contents

• Installation
• Configuration
  • Custom User Model
  • Middleware
  • Fake Migrations
  • Secret Key Replacement
• Usage
• Documentation
• Contributing
• License

Installation

Use the package manager pip to install platform-users.

pip install platform-users

Configuration

Custom User Model

Update your project's INSTALLED_APPS setting in settings.py:

INSTALLED_APPS = [
    # ...,
    'platform_users',
]

Configure the custom user model in settings.py:

AUTH_USER_MODEL = 'platform_users.Users'

Fake Migrations

Run the following command to fake migrations for the platform_users app:

python manage.py migrate platform_users --fake

Secret Key Replacement

Replace the secret key in your child project with the secret key from platform-users. Keep the secret key secure.

# Example:
# parent_project_secret_key = '<some_secret_key1>'

# child_project_secret_key = '<parent_project_secret_key>'

Usage

Refer to the documentation for detailed usage instructions.

Documentation

Visit our official documentation for comprehensive information, API references, and usage examples.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License.