{"id":15067882,"url":"https://github.com/f0laf0lu/chat-api","last_synced_at":"2026-02-25T05:09:26.349Z","repository":{"id":256425980,"uuid":"855111832","full_name":"F0laf0lu/Chat-API","owner":"F0laf0lu","description":"This is an API for a messaging application built with Django rest framework. Users can create rooms, join rooms and also send and receive messages in the rooms. Your contributions are welcome","archived":false,"fork":false,"pushed_at":"2024-09-11T05:25:45.000Z","size":22,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-16T05:44:46.855Z","etag":null,"topics":["channels","django","djangorestframework","python","websockets"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/F0laf0lu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-10T10:27:38.000Z","updated_at":"2024-11-06T13:49:18.000Z","dependencies_parsed_at":"2024-09-15T01:32:01.975Z","dependency_job_id":null,"html_url":"https://github.com/F0laf0lu/Chat-API","commit_stats":{"total_commits":4,"total_committers":1,"mean_commits":4.0,"dds":0.0,"last_synced_commit":"f00aadd6a2de443b0e1e3c99dc1764447c12359f"},"previous_names":["f0laf0lu/chat-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F0laf0lu%2FChat-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F0laf0lu%2FChat-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F0laf0lu%2FChat-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F0laf0lu%2FChat-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/F0laf0lu","download_url":"https://codeload.github.com/F0laf0lu/Chat-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243830912,"owners_count":20354850,"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":["channels","django","djangorestframework","python","websockets"],"created_at":"2024-09-25T01:28:41.591Z","updated_at":"2025-10-25T06:35:25.479Z","avatar_url":"https://github.com/F0laf0lu.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ChatApp API\n\n\n\nThe ChatApp API built with Django Rest Framework provides a set of RESTful endpoints to manage users, create rooms, join a room, send and receive messages. The API is designed to be simple to use and easy to integrate\n\n## Getting Started\nTo run the API locally, follow these steps:\n\n1.  Clone the repository: `git clonehttps://github.com/F0laf0lu/Chat-API.git`\n2.  Create a virtual environment: `python -m venv venv`\n3.  Activate the virtual environment: `source venv/bin/activate`\n4.  Install dependencies: `pip install -r requirements.txt` \n5.  Set up the database: `python manage.py migrate`\n6.  Start up a redis container in docker at port 6379\n7.  Create a superuser account: `python manage.py createsuperuser`\n8.  Start the development server: `python manage.py runserver`\n\nRunning Tests\n---------------\nTests are organized into different files within the app's `tests` directory. Here's how to run them:\n\n1. To run all the tests, use the following command:\n\n    ```\n    python manage.py test\n    ```\n\n2. To run a single test file, you can use the following command (replacing `\u003capp_name\u003e` and `\u003ctest_file\u003e` with the appropriate values):\n\n    ```\n    python manage.py test \u003capp_name\u003e.tests.\u003ctest_file\u003e\n    ```\n\nFunctional Requirements Definition\n--------------\n- User Authentication\n- Chat room creation\n- Chat room joining\n- Message Sending and receiving using websockets\n\nTech Stack\n--------------\n\n- Language: Python 3.9\n- Framework: Django 4.0+\n- Testing: Django Test Framework\n- Test Coverage: 80%+\n- Development Methodology: TDD (Test Driven Development)\n\nAuthentication\n--------------\n\nAuthentication is required for most endpoints in the API. To authenticate, include an access token in the `Authorization` header of your request. The access token can be obtained by logging in to your account or registering a new account.\n\nAPI Endpoints\n-------------\n\nThe following endpoints are available in the API:\n\n### Authentication Endpoints\n\n-   `/api/v1/users/` (POST): to allow users to register for an account.\n-   `/api/v1/auth/login/` (POST): to allow users to log in to their account.\n\n### User Endpoints\n\n-   `/api/v1/users/` (GET): to retrieve a list of all registered users. Available to admins only\n-   `/api/v1/users/\u003cuser_id\u003e/` (GET, PUT, PATCH, DELETE): to retrieve, update, partially update or delete a specific user's profile.\n- `/api/v1/users/\u003cuser_id\u003e/chatrooms` (GET) : to get all chatrooms a user belongs to \n\n### Chat room Endpoints\n-   `/api/v1/chatroom/` (GET): to retrieve a list of all available chatrooms\n-   `/api/v1/chatroom/` (POST): Create a new chatroom\n-   `/api/v1/chatroom/\u003croom_id\u003e` (GET, PUT, PATCH, DELETE):  retrieve, update, partially update or delete a chatroom.\n-   `/api/v1/chatroom/\u003croom_id\u003e/add_member` (POST): Add a new memeber to the chatroom. Only room creator can access this\n- `/api/v1/chatroom/\u003croom_id\u003e/get_members` (GET): Get all chatroom members\n- `/api/v1/chatroom/\u003croom_id\u003e/member/\u003cuser_id\u003e/` (GET): retrieve a chat room member\n- `/api/v1/chatroom/\u003croom_id\u003e/member/\u003cuser_id\u003e/` (DELETE): remove a member from the chatroom\n- `/api/v1/chatroom/\u003croom_id\u003e/chat/` (POST): Send chat messages to the room\n\n\nContributing\n------------\n\nContributions to this project are welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff0laf0lu%2Fchat-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff0laf0lu%2Fchat-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff0laf0lu%2Fchat-api/lists"}