{"id":13424980,"url":"https://github.com/yezz123/JeffQL","last_synced_at":"2025-03-15T19:32:16.979Z","repository":{"id":39828139,"uuid":"225019633","full_name":"yezz123/JeffQL","owner":"yezz123","description":"fastAPI Simple authentication \u0026 Login API using GraphQL and JWT :rocket:","archived":false,"fork":false,"pushed_at":"2024-04-29T23:21:12.000Z","size":40,"stargazers_count":29,"open_issues_count":4,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-22T00:13:13.478Z","etag":null,"topics":["asyncio","docker","fastapi","fastapi-docker","graphene","graphql","jwt","jwt-authentication","python","python3"],"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/yezz123.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"custom":"paypal.me/yassertahiri"}},"created_at":"2019-11-30T13:52:02.000Z","updated_at":"2024-07-31T02:26:21.151Z","dependencies_parsed_at":"2024-01-03T02:30:08.009Z","dependency_job_id":"0dad333d-71b5-40f4-8c29-eb2bbe7b194b","html_url":"https://github.com/yezz123/JeffQL","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2FJeffQL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2FJeffQL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2FJeffQL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2FJeffQL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yezz123","download_url":"https://codeload.github.com/yezz123/JeffQL/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243781727,"owners_count":20347136,"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":["asyncio","docker","fastapi","fastapi-docker","graphene","graphql","jwt","jwt-authentication","python","python3"],"created_at":"2024-07-31T00:01:01.468Z","updated_at":"2025-03-15T19:32:16.735Z","avatar_url":"https://github.com/yezz123.png","language":"Python","readme":"![JeffQL](.github/header.svg)\n\n# JeffQL\n\nA Simple FastAPI authentication \u0026 Login API using GraphQL and JWT.\n\n\u003e I choose this Name JeffQL cause i have a Low level Friend with a Nickname Jeff i wish he understand that Python and JavaScript is the future :rocket:\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.8.6 or higher\n- FastAPI\n- Docker\n\n### Project setup\n\n```sh\n# clone the repo\n$ git clone https://github.com/yezz123/JeffQL\n\n# move to the project folder\n$ cd JeffQL\n```\n\n### Creating virtual environment\n\n- Install `pipenv` a global python project `pip install pipenv`\n- Create a `virtual environment` for this project\n\n```shell\n# creating pipenv environment for python 3\n$ pipenv --three\n\n# activating the pipenv environment\n$ pipenv shell\n\n# if you have multiple python 3 versions installed then\n$ pipenv install -d --python 3.8\n\n# install all dependencies (include -d for installing dev dependencies)\n$ pipenv install -d\n```\n\n### Running the Application\n\n- To run the [Main](main.py) we need to use [uvicorn](https://www.uvicorn.org/) a lightning-fast ASGI server implementation, using uvloop and httptools.\n\n```sh\n# Running the application using uvicorn\n$ uvicorn main:app\n\n## To run the Application under a reload enviromment use -- reload\n$ uvicorn main:app --reload\n```\n\n## Running the Docker Container\n\n- We have the Dockerfile created in above section. Now, we will use the Dockerfile to create the image of the FastAPI app and then start the FastAPI app container.\n\n```sh\n$ docker build\n```\n\n- list all the docker images and you can also see the image `jeffql:latest` in the list.\n\n```sh\n$ docker images\n```\n\n- run the application at port 5000. The various options used are:\n\n\u003e - `-p`: publish the container's port to the host port.\n\u003e - `-d`: run the container in the background.\n\u003e - `-i`: run the container in interactive mode.\n\u003e - `-t`: to allocate pseudo-TTY.\n\u003e - `--name`: name of the container\n\n```sh\n$ docker container run -p 5000:5000 -dit --name JeffQL jeffql:latest\n```\n\n- Check the status of the docker container\n\n```sh\n$ docker container ps\n```\n\n## Preconfigured Packages\n\nIncludes preconfigured packages to kick start JeffQL by just setting appropriate configuration.\n\n| Package                                                      | Usage                                                                        |\n| ------------------------------------------------------------ | -----------------------------------------------------------------------------|\n| [uvicorn](https://www.uvicorn.org/)                          | a lightning-fast ASGI server implementation, using uvloop and httptools.     |\n| [graphene-python](https://graphene-python.org/)              | a library for building GraphQL APIs in Python easily.                        |\n| [PyJWT](https://pyjwt.readthedocs.io/en/stable/)             | a Python library which allows you to encode and decode JSON Web Tokens (JWT).|\n| [starlette](https://www.starlette.io/)                       | a lightweight ASGI framework/toolkit, which is ideal for building high performance asyncio services. |\n\n## Contributing\n\n- Join the JeffQL Creator and Contribute to the Project if you have any enhancement or add-ons to create a good and Secure Project, Help any User to Use it in a good and simple way.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","funding_links":["paypal.me/yassertahiri"],"categories":["Projects"],"sub_categories":["Open Source Projects"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyezz123%2FJeffQL","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyezz123%2FJeffQL","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyezz123%2FJeffQL/lists"}