Initial commit

.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.yaml]
+indent_style = space
+indent_size = 2

.github/workflows/static.yml

@@ -0,0 +1,52 @@
+name: Deploy Jake Website to GitHub Pages
+
+on:
+  # Runs on pushes targeting the main branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install Poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "poetry"
+
+      - name: Install Dependencies
+        run: poetry install
+      - name: Run the Jake's Generator Script
+        run: poetry run python script.py
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload dist directory
+          path: "./dist"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+dist/index.html

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Vahid Al
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,122 @@
+<h1 align="center">
+    <a href="https://github.com/thevahidal/jake">
+        <img src='docs/logo.jpeg' height='200px' style="">
+    </a>
+</h1>
+
+<div align="center">
+  Jake is a tool that allows you to effortlessly create your one-link website and deploy it on your GitHub account.
+  <br />
+  <br />
+  <a href="https://thevahidal.github.io/jake">Demo</a>
+  <br />
+  <br />
+  <a href="https://thevahidal.github.io/jake">
+      <img src='docs/demo.gif' style="">
+  </a>
+</div>
+
+## Usage
+
+### 1. Create a Repository
+
+To get started, follow these steps to create a new repository using this template:
+
+1. Click [here](https://github.com/new?template_name=jake&template_owner=thevahidal) to create a new repository.
+2. Choose a name for your repository. If you want your website to be deployed at `<yourusername>.github.io`, name your repository `<yourusername>.github.io`. Alternatively, you can choose any other name, such as `that-other-name`, which will result in your website being deployed at `<yourusername>.github.io/that-other-name/`.
+
+### 2. Enable GitHub Pages
+
+After creating the repository, you need to enable GitHub Pages. Follow these steps:
+
+1. Go to your repository's `Settings` tab.
+2. Navigate to the `Pages` section.
+3. Choose `GitHub Actions` as the source for your GitHub Pages.
+4. Click `Save` to apply the changes.
+
+### 3. Add your data
+
+To customize your website, follow these steps:
+
+1. Open your repository in your preferred text editor.
+2. Locate the `data.toml` file and update it with your information.
+
+<details>
+<summary>Click to <b>Learn</b> all the available settings here</summary>
+
+#### General Information
+
+- `name`: Your name (e.g., "Vahid Al")
+- `description`: A brief bio about yourself (e.g., "Software Developer and passionate about creating things")
+- `keywords`: Keywords for the keywords meta tag (e.g., "python, javascript, go")
+- `image`: The file address of your avatar. Place your avatar inside the `dist/img/` folder (e.g., "me.jpeg" - Note that the `/dist/img/` address is not included)
+- `theme`: Choose your website theme: "dark" or "light" (e.g., "dark")
+- `primary_color`: Specify your website's primary color using a hexadecimal color code (e.g., "#00897b")
+- `text_align`: Specify the text alignment for your website: "right", "left" or "center" (e.g., "center")
+- `gtag_id`: Your Google Analytics tracking ID (e.g., "G-33WB8LVHR6")
+- `base_url`: The base URL for your website, mentioned in **1. Create a Repository** step (e.g., <https://thevahidal.github.io/jake>)
+
+#### Sections
+
+You can add multiple sections based on your requirements.
+For example, you may want a section for your projects, another for your social media links, and another for your merchandise products.
+
+Each section is defined using `[[sections]]` and has the following components:
+
+- `title`: The title of the section (e.g., "Projects")
+- `description`: A brief description of the section (e.g., "Here are some of my projects")
+- `direction`: The direction of the section: "row" or "column" (e.g., "row")
+- `item_style`: The style of the items in the section: "outline" or "filled" (e.g., "outline")
+- `items`: The items associated with the section.
+
+#### Items
+
+Each item is defined using `[[sections.items]]` and has the following components:
+
+- `title`: The title of the item (e.g., "Soul")
+- `description`: A brief description of the item (e.g., "An SQLite REST and Real-time server")
+- `url`: The URL associated with the item (e.g., "<https://github.com/thevahidal/soul>")
+
+</details>
+
+### 4. Voila
+
+That's all you need to do. Now, you can sit back and relax while your website gets deployed. You can monitor the progress in the `Actions` tab of your repository. Once the deployment is complete, you can access your brand new one-link website at `<yourusername>.github.io` (If you chose `<yourusername>.github.io` as your repository name) or `<yourusername>.github.io/repo-name/`.
+
+### FAQ
+
+<details>
+<summary>1. How to configure my own <b>Custom Domain</b>?</summary>
+
+If you want to use your custom domain for your website hosted on GitHub Pages, it's a straightforward process. Just follow these steps:
+
+1. Go to the **Settings** tab of your GitHub repository.
+2. Select **Pages** tab in the sidebar.
+3. Under the **Custom domain** section, enter your desired domain name.
+4. Click **Save**.
+
+That's it! Your GitHub Pages site will now be accessible using your custom domain.
+
+For more detailed instructions and information on using a custom domain with GitHub Pages, you can refer to the [official GitHub Docs](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site).
+
+</details>
+
+<details>
+<summary>2. How to <b>manually</b> trigger the GitHub Action to deploy my website?</summary>
+
+1. In your repository, navigate to the "Actions" tab.
+2. Look for the workflow named "Deploy Jake Website to GitHub Pages" in the list of workflows.
+3. If you see an alert stating "This workflow has a workflow_dispatch event trigger," it means you can manually trigger the workflow.
+4. Click on the "Run Workflow" button. A new window will appear.
+5. Within the new window, click on the green "Run Workflow" button.
+6. GitHub Actions will initiate the deployment process for your static content to GitHub Pages.
+
+</details>
+
+## Contributing
+
+If you find any issues or have suggestions for improvement, please feel free to contribute by submitting a pull request or creating an issue in the repository.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).