{"id":13678557,"url":"https://github.com/yezz123/FRDP","last_synced_at":"2025-04-29T15:32:01.134Z","repository":{"id":37822399,"uuid":"391047438","full_name":"yezz123/FRDP","owner":"yezz123","description":"Boilerplate code for quick docker implementation of REST API with JWT Authentication using FastAPI, PostgreSQL and PgAdmin ⭐","archived":false,"fork":false,"pushed_at":"2024-05-27T22:47:15.000Z","size":108,"stargazers_count":64,"open_issues_count":6,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-11T06:45:42.274Z","etag":null,"topics":["asyncio","authentication","boilerplate","docker","docker-compose","fastapi","fastapi-boilerplate","jwt","jwt-authentication","pgadmin","postgres","postgresql","python","rest-api","sqlalchemy"],"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":{"github":"yezz123"}},"created_at":"2021-07-30T11:55:46.000Z","updated_at":"2024-11-07T11:46:37.000Z","dependencies_parsed_at":"2024-01-14T15:23:38.093Z","dependency_job_id":"b33de7e5-4acd-4364-80eb-6791f1bcf2c7","html_url":"https://github.com/yezz123/FRDP","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%2FFRDP","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2FFRDP/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2FFRDP/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yezz123%2FFRDP/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yezz123","download_url":"https://codeload.github.com/yezz123/FRDP/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251529563,"owners_count":21603979,"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","authentication","boilerplate","docker","docker-compose","fastapi","fastapi-boilerplate","jwt","jwt-authentication","pgadmin","postgres","postgresql","python","rest-api","sqlalchemy"],"created_at":"2024-08-02T13:00:55.102Z","updated_at":"2025-04-29T15:32:00.813Z","avatar_url":"https://github.com/yezz123.png","language":"Python","readme":"# FRDP\n\nBoilerplate code for quick docker implementation of REST API with JWT Authentication using FastAPI, PostgreSQL and PgAdmin.\n\n## Project setup\n\n```shell\n# clone the repo\n$ git clone https://github.com/yezz123/FRDP\n\n# move to the project folder\n$ cd FRDP\n```\n\n## Getting Started\n\n### Features\n\n| Auth              | Description                                                                     |\n|-------------------|---------------------------------------------------------------------------------|\n|`Login Access Token` | OAuth2 compatible token login, get an access token for future requests          |\n|`Check Session`      | Test if a user is logged in by checking if a valid access token is in the header|\n|`Recover Password`   | Password Recovery                                                               |\n|`Reset Password`     | Reset your password                                                             |\n\n| User                               | Description                                      |\n|------------------------------------|--------------------------------------------------|\n|`Create New User`                     | Create a new user                                |\n|`Get Current User By Id`              | Get current user                                 |\n|`Update Current User`                 | Update own user                                  |\n|`Update Other User (SuperUser)`       | Update a user                                    |\n|`Create User (Without Authentication)`| Create new user without the need to be logged in.|\n\n## Environment variables\n\n- [x] Using PostgreSQL as database server.\n- [x] Using PgAdmin as database client.\n- [x] Dockerized the Boilerplate code.\n\n- Drop your own Configuration at the `docker-compose.env` file.\n\n```conf\n# Backend API Configuration\nPROJECT_NAME=\nDOMAIN=\n\n# Security Configuration\nSECRET_KEY=\nUSERS_OPEN_REGISTRATION=\nEMAIL_RESET_TOKEN_EXPIRE_HOURS=\n\n# Server Settings\nSERVER_NAME=\nSERVER_HOST=\n\n# Postgres default username and password\nPOSTGRES_USER=\nPOSTGRES_PASSWORD=\nPOSTGRES_DB=\nPOSTGRES_PORT=\nPOSTGRES_SERVER=\n\n# PGADMIN_LISTEN_PORT=\nPGADMIN_DEFAULT_EMAIL=\nPGADMIN_DEFAULT_PASSWORD=\n```\n\n## Development 🚧\n\n### Features\n\n- use `hatch` to manage dependencies.\n- use `pytest` to run tests.\n- GitHub Actions to run tests, lints.\n- Use `Dependabot` to keep dependencies up to date.\n- use `pre-commit` to manage formatting and linting.\n  - use `black` to format code.\n  - use `ruff` to lint code.\n  - use `isort` to sort imports.\n\n### Setup environment 📦\n\nYou should create a virtual environment and activate it:\n\n```bash\npython -m venv venv/\n```\n\n```bash\nsource venv/bin/activate\n```\n\nAnd then install the development dependencies:\n\n```bash\n# Install dependencies\npip install -e .[test,lint]\n```\n\n### Run tests 🌝\n\nYou can run all the tests with:\n\n```bash\nbash scripts/test.sh\n```\n\n### Format the code 🍂\n\nExecute the following command to apply `pre-commit` formatting:\n\n```bash\nbash scripts/format.sh\n```\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","funding_links":["https://github.com/sponsors/yezz123"],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyezz123%2FFRDP","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyezz123%2FFRDP","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyezz123%2FFRDP/lists"}