[{"_1":2,"_162":-5,"_163":-5},"loaderData",{"_3":4,"_18":19,"_25":26,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16,"_17":11},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","dockerRebrandTour","routes/_layout",{"_20":-5,"_21":22,"_23":11,"_24":22},"username","isAskGordonEnabled",true,"showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":22,"_132":11,"_133":11,"_134":-5,"_135":11,"_136":-5,"_137":138,"_139":91,"_140":-7},"canonicalUrl","https://hub.docker.com/r/yezz123/dogeapi/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","yezz123","reponame","dogeapi","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2021-06-02T15:43:45.789372Z","description","API with high performance built with FastAPI, help to improve connection with your Backend Side.","is_private","last_updated","2021-07-17T18:34:59.199327Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1026,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n \n \n \n \n \n $\"Star$ \n \n \n \n \n\n

\n\n# DogeAPI\n\nAPI with high performance built with FastAPI & SQLAlchemy, help to improve connection with your Backend Side to create a simple blog and Cruds with OAuth2PasswordBearer ⛏\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/DogeAPI\n\n# move to the project folder\n$ cd DogeAPI\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### Configured Enviromment\n\n#### Database\n\n- To Provide a good and fast work, i choose a `SQLite` Database using `SQLAlchemy`.\n- If you want to configure the Database with an other Provider like `MySQL` or `PostgreSQL` you can change the `Database_URL` here :\n\n```py\n# here you need to inster the URI that should be used for the connection.\nSQLALCHEMY_DATABASE_URL = 'sqlite:///blog.db'\n```\n\n- For Example :\n\n```py\nSQLALCHEMY_DATABASE_URL = 'mysql://username:password@server/blog'\n```\n\n#### Models\n\n- Here for the [Models.py](models/models.py), i create 2 tables based on the requirements for this project `blogs` and `users`\n\n```py\nclass Blog(Base):\n __tablename__ = \"blogs\"\n id = Column(Integer, primary_key=True, index=True)\n title = Column(String)\n body = Column(String)\n user_id = Column(Integer, ForeignKey(\"users.id\"))\n creator = relationship(\"User\", back_populates=\"blogs\")\n```\n\n```py\nclass User(Base):\n __tablename__ = \"users\"\n id = Column(Integer, primary_key=True, index=True)\n name = Column(String)\n email = Column(String)\n password = Column(String)\n blogs = relationship(\"Blog\", back_populates=\"creator\")\n```\n\n#### Token\n\n- Set environment variables as the Secret Key and Time Expire for Token, i made it in an easy way to get it.\n- Change the `.env.sample` to `.env` then insert you String `Secret_Key` and `ACCESS_TOKEN_EXPIRE_MINUTES`.\n- you can generate the String using `openssl rand -hex 32`.\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 `dogeapi: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> - `-p`: publish the container's port to the host port.\n> - `-d`: run the container in the background.\n> - `-i`: run the container in interactive mode.\n> - `-t`: to allocate pseudo-TTY.\n> - `--name`: name of the container\n\n```sh\n$ docker container run -p 5000:5000 -dit --name DOGEAPI dogeapi: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 DogeAPI 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| [Python-Jose](https://github.com/mpdavis/python-jose) | a JavaScript Object Signing and Encryption implementation in Python. |\n| [SQLAlchemy](https://www.sqlalchemy.org/) | is the Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL. |\n| [starlette](https://www.starlette.io/) | a lightweight ASGI framework/toolkit, which is ideal for building high performance asyncio services. |\n| [passlib](https://passlib.readthedocs.io/en/stable/) | a password hashing library for Python 2 & 3, which provides cross-platform implementations of over 30 password hashing algorithms |\n| [bcrypt](https://github.com/pyca/bcrypt/) | Good password hashing for your software and your servers. |\n| [python-multipart](https://github.com/andrew-d/python-multipart) | streaming multipart parser for Python. |\n\n`yapf` packages for `linting and formatting`\n\n## Contributing\n\n- Join the DOGEAPI 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- Check all information here at [docs's Folder](docs) to understand to how to contribute or to Read the Code of Conduct.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":22,"_83":11,"_84":11},"read","write","admin","user","storage_size",1056151000,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":22},"content_type","creator",10349825,"full_size",509645177,"id",152289750,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:88dcf7285da920865bda42d063fa437511b3b6f4f1b09635469c13c43728e56a","features","","last_pulled","2026-10-29T08:37:24.304834709Z","last_pushed","2021-07-17T18:34:59Z","os","linux","os_features","os_version","size","variant","2021-07-17T18:34:58.84416Z","last_updater","last_updater_username","media_type","latest","repository",14133776,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":143,"_150":151,"_137":160,"_161":11},{"_40":144,"_42":145,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":146,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":147,"_79":11,"_80":149,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":148},[78],{"_82":22,"_83":11,"_84":11},"tags",{"_152":64,"_153":-5,"_154":-5,"_155":156},"count","next","previous","results",[157],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":158,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":22},[159],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

yezz123/dogeapi

Tags for yezz123/dogeapi