{"id":16132984,"url":"https://github.com/emmmabk/alif","last_synced_at":"2025-09-08T11:10:03.072Z","repository":{"id":201355164,"uuid":"702655499","full_name":"EMMMABK/alif","owner":"EMMMABK","description":"🔒🌐 'Authorization Alif' - A Django-based app for secure user auth, email confirmation, and news management using Django \u0026 REST framework. Empowering seamless user experiences and efficient news handling.","archived":false,"fork":false,"pushed_at":"2023-12-26T14:11:58.000Z","size":6216,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-10T22:35:27.680Z","etag":null,"topics":["authentication","authorization","backend-development","django-rest-framework","news-management","rest-api","user-management"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EMMMABK.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-10-09T18:25:33.000Z","updated_at":"2024-05-22T16:20:47.000Z","dependencies_parsed_at":"2023-11-02T10:38:25.987Z","dependency_job_id":null,"html_url":"https://github.com/EMMMABK/alif","commit_stats":null,"previous_names":["emmmabk/alif"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EMMMABK%2Falif","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EMMMABK%2Falif/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EMMMABK%2Falif/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EMMMABK%2Falif/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EMMMABK","download_url":"https://codeload.github.com/EMMMABK/alif/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221713430,"owners_count":16868257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","authorization","backend-development","django-rest-framework","news-management","rest-api","user-management"],"created_at":"2024-10-09T22:35:36.211Z","updated_at":"2024-10-27T17:53:15.925Z","avatar_url":"https://github.com/EMMMABK.png","language":"Python","readme":"# Alif Project 💻🚀\n![News](https://i.ibb.co/0h5NvqL/Purple-Modern-Breaking-News-Free-Instagram-Post.png)\n## Table of Contents\n1. [Overview](#overview)\n2. [Project Setup](#project-setup)\n   - [Requirements](#requirements)\n   - [Installation](#installation)\n   - [Database Setup](#database-setup)\n3. [API Endpoints](#api-endpoints)\n4. [Models and Serializers](#models-and-serializers)\n5. [Views](#views)\n6. [Routes](#routes)\n7. [Documentation](#documentation)\n\n## 1. Overview ℹ️\nThe \"Authorization Alif\" project is a Django application designed for user authentication, user management, email confirmation, password management, and news management using Django and Django REST framework.\n\n## 2. Project Setup 🛠️\n### Requirements ℹ️\nBefore you begin, ensure you have the following installed on your system:\n- Python\n- Django\n- Python packages listed in `requirements.txt`\n\n### Installation ⚙️\n1. **Clone this repository to your local machine:**\n   ```bash\n   git clone https://github.com/EMMMABK/authorization-alif.git\n   ```\n2. **Navigation** 🚶\n   ```bash\n   cd authorization-alif\n   ```\n3. **Install the required packages** 📦\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n## 3. Database Setup 🗃️\nBy default, this project uses SQLite as the database. You can change the database settings in `settings.py`.\n* Apply database migrations:\n```bash\npython manage.py migrate\n```\n* Create a superuser for admin access:\n```bash\npython manage.py createsuperuser\n```\n* Start the development server:\n```bash\npython manage.py runserver\n```\n\n## 4. API Endpoints 🌐\nThe project provides the following API endpoints:\n\n* User Authentication and Management\n   * POST /api/login/: User login.\n   * POST /api/register/: User registration.\n   * POST /api/email-confirmation/: Email confirmation.\n   * POST /api/password-change/: Password change.\n   * POST /api/password-reset/: Password reset.\n   * PUT /api/user/update/\u003cint:pk\u003e/: Update user profile.\n   * GET /api/users/: Get a list of users.\n   * GET /api/user/\u003cint:pk\u003e/: Get user details.\n* News Management\n   * GET /api/news/: Get a list of news.\n   * POST /api/news/create/: Create news.\n   * GET /api/news/\u003cint:pk\u003e/: Get news details.\n   * PUT /api/news/\u003cint:pk\u003e/: Update news.\n   * DELETE /api/news/\u003cint:pk\u003e/: Delete news.\n\n## 5. Models and Serializers 📋\n### User Model 👤\n* The User model represents a user in the application.\n* Fields include: email, name, surname, phone_number, is_active, is_staff, password, and more.\n* Serializers: UserSerializer, UserRegistrationSerializer, EmailConfirmationSerializer, PasswordChangeSerializer, PasswordResetSerializer, UserUpdateSerializer, UserFilterSerializer.\n\n### News Model 📰\n* The News model represents a news article.\n* Fields include: image, title, content, and created_at.\n* Serializers: NewsSerializer, NewsCreateSerializer.\n\n## 6. Views 👀\nViews in this project handle the logic for API endpoints. Important views include user authentication, registration, email confirmation, password management, and news management.\n\n## 7. Routes 🛣️\nURL routes are defined in `urls.py`. They map views to specific endpoints and HTTP methods.\n\n## 8. Documentation 📄\nFor detailed API documentation, see the official Django REST framework documentation. You can also refer to the comments within the code for more information on each API endpoint's usage.\n\nPlease note: It's important to keep your SECRET_KEY and other sensitive information secure, especially in a production environment.\n\nFeel free to customize this README.md to suit your project's specific requirements, and add any additional information or instructions as necessary.\n\nMake sure to replace `\"https://github.com/EMMMABK/authorization-alif.git\"` with the actual URL of your project's repository if it's hosted on a platform like GitHub. Additionally, customize any other parts of the README to match your project's specific needs.\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmmabk%2Falif","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femmmabk%2Falif","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femmmabk%2Falif/lists"}