{"id":19447858,"url":"https://github.com/braydentw/obsidian","last_synced_at":"2025-04-25T02:30:22.458Z","repository":{"id":40694479,"uuid":"446438342","full_name":"BraydenTW/obsidian","owner":"BraydenTW","description":"✨ Elegant portfolio template built on NextJS and Tailwind.","archived":false,"fork":false,"pushed_at":"2022-06-25T23:28:19.000Z","size":1125,"stargazers_count":56,"open_issues_count":0,"forks_count":13,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-18T13:03:44.286Z","etag":null,"topics":["dark-mode","javascript","js","next","nextjs","portfolio","react","reactjs","tailwind","tailwindcss","vercel"],"latest_commit_sha":null,"homepage":"https://obsidian-portfolio.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BraydenTW.png","metadata":{"files":{"readme":"README.md","changelog":"changeFavicon.png","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-10T13:39:38.000Z","updated_at":"2025-03-21T20:41:04.000Z","dependencies_parsed_at":"2022-08-10T00:40:54.306Z","dependency_job_id":null,"html_url":"https://github.com/BraydenTW/obsidian","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BraydenTW%2Fobsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BraydenTW%2Fobsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BraydenTW%2Fobsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BraydenTW%2Fobsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BraydenTW","download_url":"https://codeload.github.com/BraydenTW/obsidian/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250741840,"owners_count":21479679,"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":["dark-mode","javascript","js","next","nextjs","portfolio","react","reactjs","tailwind","tailwindcss","vercel"],"created_at":"2024-11-10T16:21:05.238Z","updated_at":"2025-04-25T02:30:22.014Z","avatar_url":"https://github.com/BraydenTW.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/braydenw","https://paypal.me/braydentw"],"categories":[],"sub_categories":[],"readme":"# Obsidian\n\n![Obsidian banner](cover.png)\n\n_✨ Obsidian is a minimal and lightweight portfolio template built on NextJS and TailwindCSS. ✨_\n\n* [Setup](#setup)\n    * [Install the dependencies](#install-the-dependencies)\n    * [Edit content](#edit-content)\n    * [Change the Favicon](#change-the-favicon)\n* [Try it out!](#try-it-out)\n    * [Run locally!](#run-locally)\n    * [Deploy onto a live website!](#deploy-onto-a-live-website)\n* [About the developer](#about-the-developer)\n\n\n## Setup\n\nFirst, start by clicking the 'Use this template' button. It will create a clone of this repository.\n\n\u003cimg src=\"step1.png\" alt=\"Step one\" width=\"500\" /\u003e\n\nThen, name it whatever ya want. (Just not \"animated-palm-tree\" haha)\n\n\u003cimg src=\"step2.png\" alt=\"Step two\" width=\"500\" /\u003e\n\nOnce finished creating your new repository, enter the following command into your terminal: (replace the values with your github username and repository name from earlier and enter into that directory)\n\n```\ngit clone https://github.com/\u003c--USER--\u003e/\u003c--REPO--\u003e\ncd \u003c--FOLDER-NAME--\u003e\n```\n\n### Install the dependencies\n\nBa-da-boom! Your code is all there.... however you need to install dependencies like React, NextJS, and TailwindCSS into your project so the stuff actually works! Do so by installing them with the package manager of your choice:\n\n```bash\n# NPM\nnpm i\n\n# Yarn\nyarn\n```\n\n### Edit content\n\nNow, before you run it locally, you should edit the content first!\n\nTo do so, open the `data/config.js` file and edit the values to what makes you, you!\n\nAlso, replace the image located in `public/static/profile.png` with a picture of yourself! Or a cool avatar! Or just keep it the same if you are actually LeBron James! (Hey LeBron if you're looking at this, then \"hello world\" to you!)\n\n### Change the Favicon\n\nSo... you want to change that icon that shows up on your browser tab for your portfolio? (aka: A \"Favicon\")\n\n\u003cimg src=\"./changeFavicon.png\" alt=\"LeBron Favicon\" width=\"200\" /\u003e\n\nFollow these steps:\n\n1. Create your logo and download it on your computer\n2. Go to a favicon generator site like [favicon.io](https://favicon.io), go through the steps to get you icon files.\n3. Place those files in the `public/static/favicon/` like so:\n\n    \u003cimg src=\"./faviconFolder.png\" alt=\"Favicon folder\" width=\"300\" /\u003e\n\nThen it should be ready!\n\n## Try it out!\n\n### Run locally!\n\nTo see it in action in your browser, run the `dev` script:\n\n```bash\n# NPM\nnpm run dev\n\n# Yarn\nyarn dev\n```\n\n**_Ta-da!_** 🎉\n\n### Deploy onto a live website!\n\nNow, how do you get this published for all the world to see? [Vercel](https://vercel.com) is an awesome and 100% free option for this. \n\nSignup for free with your Github account and click the \"New Project\" button on your dashboard.\n\n\u003cimg src=\"./vercel.png\" alt=\"New Project button\" width=\"600\"\u003e\n\nImport the github repository you just created then after some loading...\n\n![Mission accomplished](./gronk.gif)\n\nYou're brand new portfolio should be ready to go!\n\nShare it with some friends, family members, employers?\n\n---\n\n## About the developer\n\n\u003ch3\u003e\u003ca href=\"https://github.com/braydentw\"\u003e@BraydenTW\u003c/a\u003e\u003c/h3\u003e\nHey there! My name is Brayden and I'm a Frontend Developer and Designer building and designing awesome stuff for the web! I like to work with technologies like NextJS, TailwindCSS, and exploring the JavaScript ecosystem.\n\u003cbr /\u003e\u003cbr /\u003e\nLike my work?\n\u003cbr /\u003e\u003cbr /\u003e\n\u003ca href=\"https://www.buymeacoffee.com/braydenw\" target=\"_blank\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/BraydenTW/BraydenTW/master/buy-me-a-coffee.svg\" alt=\"Buy Me A Coffee: @BraydenW\" width=\"160\"\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n\u003ca href=\"https://paypal.me/braydentw\" target=\"_blank\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/BraydenTW/BraydenTW/master/paypal.svg\" alt=\"PayPal: @BraydenTW\" width=\"160\"\u003e\u003c/a\u003e\n\n\u003chr\u003e\n\n\u003cp\u003eThank you so much for your support. 💖\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraydentw%2Fobsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbraydentw%2Fobsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraydentw%2Fobsidian/lists"}