README.md

About  |   Technology  |   Getting Started  |   Roadmap  |   Contributing  |   License

Custom User Mode

Fully replace the username field with an email field for Django authentication.

About the Project

This project is a customization in the Django user model.

Django's authentication by username has been completely replaced by the user's email.

Technology

This project was developed with the following technologies:

• Python
• Django Framework
• Django REST Framework
• Docker
• Docker Compose

Getting Started

Prerequisites

• Python
• Docker
• Docker Compose

Install and Run

1. Clone the repository:

git clone https://github.com/WesGtoX/CustomUserModel.git

2. Set a SECRET_KEY in .env:

cp .env.sample .env

3. Run:

make run

4. Run tests:

make test

Roadmap

See the open issues for a list of proposed features (and known issues).

How to contribute

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project.
2. Create your Feature Branch git checkout -b feat/my-feature.
3. Commit your Changes git commit -m 'feat: My new feature'.
4. Push to the Branch git push origin feat/my-feature.
5. Open a Pull Request.

After the merge of your pull request is done, you can delete your branch.

License

Distributed under the MIT License. See LICENSE for more information.

---

Made with ♥ by Wesley Mendes 👋