https://github.com/wesgtox/customusermodel
Fully replace the username field with an email field for Django authentication.
https://github.com/wesgtox/customusermodel
api custom-user-model django django-rest-framework pytest python test
Last synced: 3 months ago
JSON representation
Fully replace the username field with an email field for Django authentication.
- Host: GitHub
- URL: https://github.com/wesgtox/customusermodel
- Owner: WesGtoX
- License: mit
- Created: 2020-08-17T22:56:07.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-08T22:32:25.000Z (about 4 years ago)
- Last Synced: 2025-03-09T19:42:50.585Z (7 months ago)
- Topics: api, custom-user-model, django, django-rest-framework, pytest, python, test
- Language: Python
- Homepage:
- Size: 92.8 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://www.python.org/)
- [Django Framework](https://www.djangoproject.com/)
- [Django REST Framework](https://www.django-rest-framework.org/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
## Getting Started
### Prerequisites
- [Python](https://www.python.org/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
### Install and Run
1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/CustomUserModel.git
```
2. Set a `SECRET_KEY` in `.env`:
```bash
cp .env.sample .env
```
3. Run:
```bash
make run
```
4. Run tests:
```bash
make test
```
## Roadmap
See the [open issues](https://github.com/WesGtoX/CustomUserModel/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](LICENSE) for more information.
---
Made with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave: