{"id":22135137,"url":"https://github.com/kayprogrammer/socialnet-v5","last_synced_at":"2025-03-24T10:12:39.640Z","repository":{"id":222897701,"uuid":"758587142","full_name":"kayprogrammer/socialnet-v5","owner":"kayprogrammer","description":"A Social Networking API built with Litestar and Tortoise ORM","archived":false,"fork":false,"pushed_at":"2024-03-14T11:05:09.000Z","size":838,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T15:21:52.350Z","etag":null,"topics":["litestar","litestar-framework","pgadmin4","postgresql","tortoise-orm"],"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/kayprogrammer.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}},"created_at":"2024-02-16T16:32:29.000Z","updated_at":"2024-03-06T21:34:41.000Z","dependencies_parsed_at":"2024-03-03T20:37:48.932Z","dependency_job_id":null,"html_url":"https://github.com/kayprogrammer/socialnet-v5","commit_stats":null,"previous_names":["kayprogrammer/socialnet-v5"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kayprogrammer%2Fsocialnet-v5","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kayprogrammer%2Fsocialnet-v5/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kayprogrammer%2Fsocialnet-v5/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kayprogrammer%2Fsocialnet-v5/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kayprogrammer","download_url":"https://codeload.github.com/kayprogrammer/socialnet-v5/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245249219,"owners_count":20584497,"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":["litestar","litestar-framework","pgadmin4","postgresql","tortoise-orm"],"created_at":"2024-12-01T19:13:51.905Z","updated_at":"2025-03-24T10:12:39.608Z","avatar_url":"https://github.com/kayprogrammer.png","language":"Python","readme":"# SOCIALNET V5\nA Realtime Social Networking API built with Litestar and Tortoise ORM\n\n\n![alt text](https://github.com/kayprogrammer/socialnet-v5/blob/main/display/litestar.svg?raw=true)\n\n\n#### LITESTAR DOCS: [Documentation](https://docs.litestar.dev/latest/)\n#### TORTOISE ORM DOCS: [Documentation](https://tortoise.github.io/index.html) \n#### PG ADMIN: [Documentation](https://pgadmin.org) \n\n\n## How to run locally\n\n* Download this repo or run: \n```bash\n    $ git clone git@github.com:kayprogrammer/socialnet-V5.git\n```\n\n#### In the root directory:\n- Install all dependencies\n```bash\n    $ pip install -r requirements.txt\n```\n- Create an `.env` file and copy the contents from the `.env.example` to the file and set the respective values. A postgres database can be created with PG ADMIN or psql\n\n- Run Locally\n```bash\n    $ aerich init-db\n```\n```bash\n    $ aerich mig\n```\n```bash\n    $ litestar run --reload --debug\n```\n\n- Run With Docker\n```bash\n    $ docker-compose up --build -d --remove-orphans\n```\nOR\n```bash\n    $ make build\n```\n\n- Test Coverage\n```bash\n    $ pytest --disable-warnings -vv\n```\nOR\n```bash\n    $ make test\n```\n\n![alt text](https://github.com/kayprogrammer/socialnet-V5/blob/main/display/display1.png?raw=true)\n![alt text](https://github.com/kayprogrammer/socialnet-V5/blob/main/display/display2.png?raw=true)\n![alt text](https://github.com/kayprogrammer/socialnet-V5/blob/main/display/display3.png?raw=true)\n![alt text](https://github.com/kayprogrammer/socialnet-V5/blob/main/display/display4.png?raw=true)\n![alt text](https://github.com/kayprogrammer/socialnet-V5/blob/main/display/display5.png?raw=true)\n![alt text](https://github.com/kayprogrammer/socialnet-V5/blob/main/display/display6.png?raw=true)\n![alt text](https://github.com/kayprogrammer/socialnet-V5/blob/main/display/display7.png?raw=true)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkayprogrammer%2Fsocialnet-v5","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkayprogrammer%2Fsocialnet-v5","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkayprogrammer%2Fsocialnet-v5/lists"}