docs: add starter documentation files

Author: NickNaskida

README.md

@@ -1,5 +1,5 @@
-<p align="center" mar>
- <a href=""><img src="./logo.png" alt="FastAPI-allauth" width="80%"/></a>
+<p align="center">
+ <a href=""><img src="./docs/img/logo.png" alt="FastAPI-allauth" width="85%"/></a>
 </p>
 <p align="center">
  <em>⚡ Powerful and Secure Authentication tool for FastAPI ⚡</em>

docs/en/docs/img/favicon.png

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+ mkdocs.yml # The configuration file.
+ docs/
+  index.md # The documentation homepage.
+  ... # Other markdown pages, images and other files.

docs/en/docs/img/logo.svg

@@ -0,0 +1,237 @@
+site_name: FastAPI-secure-jwt
+site_description: Powerful and Secure Authentication tool for FastAPI
+site_author: Nikoloz Naskidashvili
+site_url: https://fastapi-secure-jwt.github.io
+
+theme:
+ name: "material"
+ highlightjs: true
+ palette:
+ - media: '(prefers-color-scheme: light)'
+ scheme: default
+ primary: teal
+ accent: amber
+ toggle:
+ icon: material/lightbulb
+ name: Switch to light mode
+ - media: '(prefers-color-scheme: dark)'
+ scheme: slate
+ primary: teal
+ accent: amber
+ toggle:
+ icon: material/lightbulb-outline
+ name: Switch to dark mode
+ features:
+ - search.suggest
+ - search.highlight
+ - content.tabs.link
+ icon:
+ repo: fontawesome/brands/github-alt
+ logo: img/logo.svg
+ favicon: img/favicon.png
+ language: en
+
+repo_name: NickNaskida/FastAPI-secure-jwt
+repo_url: https://github.com/NickNaskida/FastAPI-secure-jwt
+edit_uri: ''
+
+plugins:
+- search
+#- markdownextradata:
+# data: data
+
+#nav:
+#- FastAPI: index.md
+#- Languages:
+# - en: /
+# - az: /az/
+# - de: /de/
+# - es: /es/
+# - fa: /fa/
+# - fr: /fr/
+# - he: /he/
+# - id: /id/
+# - it: /it/
+# - ja: /ja/
+# - ko: /ko/
+# - nl: /nl/
+# - pl: /pl/
+# - pt: /pt/
+# - ru: /ru/
+# - sq: /sq/
+# - sv: /sv/
+# - tr: /tr/
+# - uk: /uk/
+# - zh: /zh/
+#- features.md
+#- fastapi-people.md
+#- python-types.md
+#- Tutorial - User Guide:
+# - tutorial/index.md
+# - tutorial/first-steps.md
+# - tutorial/path-params.md
+# - tutorial/query-params.md
+# - tutorial/body.md
+# - tutorial/query-params-str-validations.md
+# - tutorial/path-params-numeric-validations.md
+# - tutorial/body-multiple-params.md
+# - tutorial/body-fields.md
+# - tutorial/body-nested-models.md
+# - tutorial/schema-extra-example.md
+# - tutorial/extra-data-types.md
+# - tutorial/cookie-params.md
+# - tutorial/header-params.md
+# - tutorial/response-model.md
+# - tutorial/extra-models.md
+# - tutorial/response-status-code.md
+# - tutorial/request-forms.md
+# - tutorial/request-files.md
+# - tutorial/request-forms-and-files.md
+# - tutorial/handling-errors.md
+# - tutorial/path-operation-configuration.md
+# - tutorial/encoder.md
+# - tutorial/body-updates.md
+# - Dependencies:
+# - tutorial/dependencies/index.md
+# - tutorial/dependencies/classes-as-dependencies.md
+# - tutorial/dependencies/sub-dependencies.md
+# - tutorial/dependencies/dependencies-in-path-operation-decorators.md
+# - tutorial/dependencies/global-dependencies.md
+# - tutorial/dependencies/dependencies-with-yield.md
+# - Security:
+# - tutorial/security/index.md
+# - tutorial/security/first-steps.md
+# - tutorial/security/get-current-user.md
+# - tutorial/security/simple-oauth2.md
+# - tutorial/security/oauth2-jwt.md
+# - tutorial/middleware.md
+# - tutorial/cors.md
+# - tutorial/sql-databases.md
+# - tutorial/bigger-applications.md
+# - tutorial/background-tasks.md
+# - tutorial/metadata.md
+# - tutorial/static-files.md
+# - tutorial/testing.md
+# - tutorial/debugging.md
+#- Advanced User Guide:
+# - advanced/index.md
+# - advanced/path-operation-advanced-configuration.md
+# - advanced/additional-status-codes.md
+# - advanced/response-directly.md
+# - advanced/custom-response.md
+# - advanced/additional-responses.md
+# - advanced/response-cookies.md
+# - advanced/response-headers.md
+# - advanced/response-change-status-code.md
+# - advanced/advanced-dependencies.md
+# - Advanced Security:
+# - advanced/security/index.md
+# - advanced/security/oauth2-scopes.md
+# - advanced/security/http-basic-auth.md
+# - advanced/using-request-directly.md
+# - advanced/dataclasses.md
+# - advanced/middleware.md
+# - advanced/sql-databases-peewee.md
+# - advanced/async-sql-databases.md
+# - advanced/nosql-databases.md
+# - advanced/sub-applications.md
+# - advanced/behind-a-proxy.md
+# - advanced/templates.md
+# - advanced/graphql.md
+# - advanced/websockets.md
+# - advanced/events.md
+# - advanced/custom-request-and-route.md
+# - advanced/testing-websockets.md
+# - advanced/testing-events.md
+# - advanced/testing-dependencies.md
+# - advanced/testing-database.md
+# - advanced/async-tests.md
+# - advanced/settings.md
+# - advanced/conditional-openapi.md
+# - advanced/extending-openapi.md
+# - advanced/openapi-callbacks.md
+# - advanced/wsgi.md
+# - advanced/generate-clients.md
+#- async.md
+#- Deployment:
+# - deployment/index.md
+# - deployment/versions.md
+# - deployment/https.md
+# - deployment/manually.md
+# - deployment/concepts.md
+# - deployment/deta.md
+# - deployment/server-workers.md
+# - deployment/docker.md
+#- project-generation.md
+#- alternatives.md
+#- history-design-future.md
+#- external-links.md
+#- benchmarks.md
+#- help-fastapi.md
+#- contributing.md
+#- release-notes.md
+#markdown_extensions:
+#- toc:
+# permalink: true
+#- markdown.extensions.codehilite:
+# guess_lang: false
+#- mdx_include:
+# base_path: docs
+#- admonition
+#- codehilite
+#- extra
+#- pymdownx.superfences:
+# custom_fences:
+# - name: mermaid
+# class: mermaid
+# format: !!python/name:pymdownx.superfences.fence_code_format ''
+#- pymdownx.tabbed:
+# alternate_style: true
+#- attr_list
+#- md_in_html
+#extra:
+# analytics:
+# provider: google
+# property: UA-133183413-1
+# social:
+# - icon: fontawesome/brands/github-alt
+# link: https://github.com/tiangolo/fastapi
+# - icon: fontawesome/brands/discord
+# link: https://discord.gg/VQjSZaeJmf
+# - icon: fontawesome/brands/twitter
+# link: https://twitter.com/fastapi
+# - icon: fontawesome/brands/linkedin
+# link: https://www.linkedin.com/in/tiangolo
+# - icon: fontawesome/brands/dev
+# link: https://dev.to/tiangolo
+# - icon: fontawesome/brands/medium
+# link: https://medium.com/@tiangolo
+# - icon: fontawesome/solid/globe
+# link: https://tiangolo.com
+# alternate:
+# - link: /
+# name: en - English
+# - link: /az/
+# name: az
+# - link: /de/
+# name: de
+# - link: /es/
+# name: es - español
+# - link: /fa/
+# name: fa
+# - link: /fr/
+# name: fr - français
+# - link: /he/
+# name: he
+# - link: /id/
+# name: id
+# - link: /it/
+# name: it - italiano
+# - link: /ja/
+# name: ja - 日本語
+# - link: /ko/
+# name: ko - 한국어
+# - link: /nl/
+# name: nl
+# - link: /pl/
+# name: pl

docs/en/docs/index.md

@@ -1,6 +1,7 @@
 from fastapi import FastAPI
 
 from fastapi_secure_jwt.router.auth import auth_router
+from fastapi_secure_jwt.jwt import generate_jwt_token, decode_jwt_token
 
 app = FastAPI()
 app.include_router(
@@ -9,6 +10,8 @@
  tags=["auth"],
 )
 
+SECRET_KEY = "NOT_A_SECRET_KEY"
+
 
 @app.get("/")
 async def root():
@@ -18,3 +21,27 @@ async def root():
 @app.get("/hello/{name}")
 async def say_hello(name: str):
  return {"message": f"Hello {name}"}
+
+
+@app.get("/token")
+async def get_token():
+ return generate_jwt_token(
+ "NickNaskida",
+ "access",
+ SECRET_KEY,
+ lifetime=60 * 15,
+ claims={
+ "name": "Nick Naskidashvili",
+ "email": "nick@gmail.com",
+ "age": 25,
+ "role": "admin"
+ }
+ )
+
+
+@app.get("/decode-token")
+async def decode_token(token: str):
+ return decode_jwt_token(
+ token,
+ SECRET_KEY
+ )