{"id":28514043,"url":"https://github.com/vlymar-dev/jornaly_api","last_synced_at":"2025-07-04T11:31:52.012Z","repository":{"id":249176604,"uuid":"830130045","full_name":"vlymar-dev/JornalY_API","owner":"vlymar-dev","description":"API of the Social Network for publishing personal diaries","archived":false,"fork":false,"pushed_at":"2024-07-22T17:48:56.000Z","size":51,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-09T01:33:31.712Z","etag":null,"topics":["cors-headers","django-filter","django-rest-framework","djoser","flake8","isort","pillow","python","simplejwt"],"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/vlymar-dev.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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-07-17T16:44:35.000Z","updated_at":"2024-08-16T18:35:30.000Z","dependencies_parsed_at":"2025-04-24T07:53:22.435Z","dependency_job_id":"a03adeb9-6d9c-4080-a222-71b85fc49db0","html_url":"https://github.com/vlymar-dev/JornalY_API","commit_stats":null,"previous_names":["dev-lymar/jornaly_api","vlymar-dev/jornaly_api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vlymar-dev/JornalY_API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vlymar-dev%2FJornalY_API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vlymar-dev%2FJornalY_API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vlymar-dev%2FJornalY_API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vlymar-dev%2FJornalY_API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vlymar-dev","download_url":"https://codeload.github.com/vlymar-dev/JornalY_API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vlymar-dev%2FJornalY_API/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263501720,"owners_count":23476476,"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":["cors-headers","django-filter","django-rest-framework","djoser","flake8","isort","pillow","python","simplejwt"],"created_at":"2025-06-09T01:30:33.800Z","updated_at":"2025-07-04T11:31:51.910Z","avatar_url":"https://github.com/vlymar-dev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Python](https://img.shields.io/badge/Python-3.12-3776AB?style=flat\u0026labelColor=333333\u0026logo=Python\u0026logoColor=yellow)](https://www.python.org/)\n[![Django REST Framework](https://img.shields.io/badge/Django%20REST%20Framework-3.15.2-092E20?style=flat\u0026labelColor=333333\u0026logo=django\u0026logoColor=white)](https://www.django-rest-framework.org/)\n[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-16.3-336791?style=flat\u0026labelColor=333333\u0026logo=PostgreSQL\u0026logoColor=white)](https://www.postgresql.org/)\n[![Docker](https://img.shields.io/badge/Docker--2496ED?style=flat\u0026labelColor=333333\u0026logo=Docker\u0026logoColor=white)](https://www.docker.com/)\n[![Docker Compose](https://img.shields.io/badge/Docker-Compose-2496ED?style=flat\u0026labelColor=333333\u0026logo=Docker\u0026logoColor=white)](https://www.docker.com/)\n[![Nginx](https://img.shields.io/badge/Nginx-1.26.1-269539?style=flat\u0026labelColor=333333\u0026logo=Nginx\u0026logoColor=white)](https://www.nginx.com/)\n[![Psycopg2-binary](https://img.shields.io/badge/Psycopg2--binary-2.9.9-4169E1?style=flat\u0026labelColor=333333)](https://pypi.org/project/psycopg2-binary/)\n[![Gunicorn](https://img.shields.io/badge/Gunicorn-22.0.0-FFD700?style=flat\u0026labelColor=333333\u0026logo=Gunicorn\u0026logoColor=white)](https://gunicorn.org/)\n[![djoser](https://img.shields.io/badge/djoser-2.2.3-blue?style=flat\u0026labelColor=333333\u0026logo=django\u0026logoColor=white\u0026color=blue)](https://djoser.readthedocs.io/en/latest/getting_started.html)\n\n[![Flake8](https://img.shields.io/badge/flake8-checked-blueviolet?style=flat\u0026labelColor=333333)](https://flake8.pycqa.org/en/latest/)\n[![isort](https://img.shields.io/badge/isort-checked-violet?style=flat\u0026labelColor=333333)](https://pycqa.github.io/isort/)\n\n# JornalY_API\n\n### Table of contents:\n- [Project Description](#Project-Description)\n- [Getting Started](#Getting-Started)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n\n## Project Description\n***Built with Django 5 and Django REST Framework (DRF), this web application offers robust functionality for managing users, posts, and social interactions through a RESTful API.*** \n\n***Key features include:***\n\n**Post Management**\n - Create Posts: Users can create new posts and attach images to them.\n - Edit Posts: Authors can edit the content of their own posts.\n - Comments: Users can add comments to posts.\n - Tags: Users can create and assign tags to posts to categorize content.\n\n**Social Features**\n - Subscriptions: Users can subscribe to and unsubscribe from other authors to follow their posts.\n\n**Testing**\n - All features have been thoroughly tested to ensure reliability and functionality.\n\n\n## Getting Started\n**To get started with the project, follow these steps:**\n1. Clone the repository and navigate to the project directory:\n\n```sh\ngit clone https://github.com/dev-lymar/JornalY_API.git\ncd JornalY_API\n```\n2. Configure .env\n```sh\nreplace env.example with your data\n```\n3. Install [`Docker`](https://www.docker.com/)\n   and [`Docker Compose`](https://docs.docker.com/compose/) for your operating system.\n\n\n4. Start the project from root directory:\n ```sh\ndocker-compose up -d --build\n```\n5. Execute the commands one at a time:\n```sh\ndocker-compose exec web python manage.py migrate\ndocker-compose exec web python manage.py createsuperuser\ndocker-compose exec web python manage.py collectstatic --no-input\n```\n\n\n#### Open your web browser and navigate to http://localhost:80 to access the application.\n\n## Usage\n\nOnce the development server is running, you can access the API at http://127.0.0.1:80/.\nYou can use tools like curl, Postman, or any REST client to interact with the API endpoints.\n\nFor example, to view the list of posts, you can send a GET request to /api/v1/posts/, and you will receive a list of posts.\n\n## Contributing\nIf you would like to contribute to this project, please fork the repository and submit a pull request. \nFor major changes, please open an issue first to discuss what you would like to change.\n\n## License\nThis project is licensed under the MIT License. See the LICENSE file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvlymar-dev%2Fjornaly_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvlymar-dev%2Fjornaly_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvlymar-dev%2Fjornaly_api/lists"}