-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
799ed61
commit 5a12a8e
Showing
1 changed file
with
43 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,115 +1,66 @@ | ||
| <p align="center"> | ||
| <a href="https://cara.lekoarts.de"> | ||
| <img alt="LekoArts" src="https://img.lekoarts.de/gatsby/gatsby-site-illustration.png" /> | ||
| </a> | ||
| </p> | ||
| <h1 align="center"> | ||
| Gatsby Starter Portfolio: Cara | ||
| </h1> | ||
| # 🌐 My Personal Website | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/LekoArts/gatsby-starter-portfolio-cara/blob/master/LICENSE"> | ||
| <img src="https://img.shields.io/badge/license-0BSD-blue.svg" alt="Gatsby Starter Portfolio: Cara is released under the 0BSD license." /> | ||
| </a> | ||
| <a href="https://github.com/sponsors/LekoArts"> | ||
| <img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/LekoArts"> | ||
| </a> | ||
| <a href="https://www.lekoarts.de?utm_source=cara&utm_medium=Starter"> | ||
| <img alt="Website" src="https://img.shields.io/badge/-website-blue"> | ||
| </a> | ||
| <a href="https://twitter.com/intent/follow?screen_name=lekoarts_de"> | ||
| <img src="https://img.shields.io/twitter/follow/lekoarts_de.svg?label=Follow%20@lekoarts_de" alt="Follow @lekoarts_de" /> | ||
| </a> | ||
| </p> | ||
| Welcome to the repository for my personal website! This site is statically generated with [Gatsby](https://www.gatsbyjs.com/), a blazing-fast framework for building static websites with React. 🚀 | ||
|
|
||
| Playful and Colorful One-Page portfolio featuring Parallax effects and animations. Using the Gatsby Theme [`@lekoarts/gatsby-theme-cara`](https://github.com/LekoArts/gatsby-themes/tree/main/themes/gatsby-theme-cara). | ||
| ## 🛠️ Tech Stack | ||
|
|
||
| [**Demo Website**](https://cara.lekoarts.de) | ||
| - **Framework**: [Gatsby](https://www.gatsbyjs.com/) | ||
| - **Language**: [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) / [TypeScript](https://www.typescriptlang.org/) | ||
| - **Styling**: [Theme UI](https://theme-ui.com/) | ||
| - **Content**: [Markdown](https://www.markdownguide.org/) | ||
| - **Hosting**: [GitHub pages](https://www.github.com/) | ||
|
|
||
| Also be sure to check out other [Free & Open Source Gatsby Themes](https://themes.lekoarts.de) and my [Personal Website](https://www.lekoarts.de?utm_source=cara&utm_medium=Starter). | ||
| ## 🚀 Features | ||
|
|
||
| ## ✨ Features | ||
| - **Blazing Fast** ⚡️ | ||
| - **SEO Optimized** 🔍 | ||
| - **Responsive Design** 📱💻🖥️ | ||
| - **Easy to Customize** ✨ | ||
| - **Blog Support** 📝 | ||
|
|
||
| - Theme UI-based theming | ||
| - react-spring Parallax Effect | ||
| - CSS Animations on Shapes | ||
| ## 📚 Getting Started | ||
|
|
||
| ## ⏱️ Quick Start | ||
| 1. **Clone the repository**: | ||
|
|
||
| Deploy this starter with one click on [Netlify](https://app.netlify.com/signup): | ||
| ```bash | ||
| git clone https://github.com/l-alexandrov/personal-website.git | ||
| cd personal-website | ||
| ``` | ||
|
|
||
| [<img src="https://www.netlify.com/img/deploy/button.svg" alt="Deploy to Netlify" />](https://app.netlify.com/start/deploy?repository=https://github.com/LekoArts/gatsby-starter-portfolio-cara) | ||
| 2. **Install dependencies**: | ||
|
|
||
| ## 🚀 Getting Started | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ### 1. **Create a Gatsby site.** | ||
| 3. **Run the development server**: | ||
|
|
||
| Use the Gatsby CLI to clone the site and install dependencies: | ||
| ```bash | ||
| npx gatsby develop | ||
| ``` | ||
|
|
||
| ```sh | ||
| npx gatsby new gatsby-starter-portfolio-cara https://github.com/LekoArts/gatsby-starter-portfolio-cara | ||
| ``` | ||
| 4. **Open your browser** and visit `http://localhost:8000` to see your website in action! | ||
|
|
||
| ### 2. **Navigate to your new project.** | ||
| 5. **Building and Deployment**: | ||
|
|
||
| ```sh | ||
| cd gatsby-starter-portfolio-cara | ||
| ``` | ||
| To create a production build, run: | ||
|
|
||
| ### 3. **Open the code and start customizing!** | ||
| ```bash | ||
| npx gatsby build | ||
| ``` | ||
|
|
||
| Start the site by running `npm run develop`. | ||
| ## 🤝 Contributing | ||
|
|
||
| Your site is now running at `http://localhost:8000`! | ||
| Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/l-alexandrov/personal-website/issues) if you want to contribute. | ||
|
|
||
| If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can check out this [shorter](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/using-a-gatsby-theme/) or [longer](https://www.gatsbyjs.com/tutorial/using-a-theme/) tutorial. The tutorials don't exactly apply to this starter however the concepts are the same. | ||
| ## 📄 License | ||
|
|
||
| ## 📝 Using and modifying this starter | ||
| This project is licensed under the MIT License. See the LICENSE file for more details. | ||
|
|
||
| **Important Note:** Please read the guide [Shadowing in Gatsby Themes](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/shadowing/) to understand how to customize the underlying theme! | ||
| ## 🙏 Acknowledgements | ||
|
|
||
| This starter creates a new Gatsby site that installs and configures the theme [`@lekoarts/gatsby-theme-cara`](https://github.com/LekoArts/gatsby-themes/tree/main/themes/gatsby-theme-cara). | ||
| - Thanks to the [Gatsby](https://github.com/gatsbyjs/gatsby) team for the awesome framework | ||
| - [LekoArts](https://github.com/LekoArts) | ||
| - Shoutout to the creators of the plugins and dependencies used in this project | ||
|
|
||
| Have a look at the theme's README and files to see what options are available and how you can shadow the various components including Theme UI. Generally speaking you will want to place your files into `src/@lekoarts/gatsby-theme-cara/` to shadow/override files. The Theme UI config can be configured by shadowing its files in `src/gatsby-plugin-theme-ui/`. | ||
|
|
||
| ### Changing content | ||
|
|
||
| The content of this project is defined in four `.mdx` files inside the theme's `sections` folder. You can override the files `intro.mdx`, `projects.mdx`, `about.mdx` and `contact.mdx`. This starter has overridden all files for you already. | ||
|
|
||
| You have to use the `<ProjectCard />` component inside `projects.mdx` to display the cards. Example: | ||
|
|
||
| ```md | ||
| ## Projects | ||
|
|
||
| <ProjectCard title="Freiheit" link="https://www.behance.net/gallery/58937147/Freiheit" bg="linear-gradient(to right, #D4145A 0%, #FBB03B 100%)"> | ||
| This project is my entry to Adobe's #ChallengeYourPerspective contest. | ||
| </ProjectCard> | ||
| ``` | ||
|
|
||
| ### Change your `static` folder | ||
|
|
||
| The `static` folder contains the icons, social media images and `robots.txt`. Don't forget to change these files, too! You can use [Real Favicon Generator](https://realfavicongenerator.net/) to generate the image files inside `static`. | ||
|
|
||
| ## 🤔 Questions or problems? | ||
|
|
||
| If you have general questions or need help with Gatsby, please go to one of the [support platforms](https://www.gatsbyjs.com/contributing/community/#where-to-get-support) mentioned in Gatsby's documentation. If you have a specific question about this project, you can head to the [GitHub Discussions](https://github.com/LekoArts/gatsby-themes/discussions) of the repository. | ||
|
|
||
| ## 🎓 Learning Gatsby | ||
|
|
||
| Looking for more guidance? Full documentation for Gatsby lives [on Gatsby's website](https://www.gatsbyjs.com/). | ||
|
|
||
| ### Themes | ||
|
|
||
| To learn more about Gatsby themes specifically, I recommend checking out the [theme docs](https://www.gatsbyjs.com/docs/themes/). | ||
|
|
||
| ### General | ||
|
|
||
| - **For most developers, I recommend starting with the [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/docs/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. | ||
|
|
||
| - **To dive straight into code samples, head [to Gatsby's documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the _How-to Guides_ and _Reference_ items in the primary navigation. | ||
|
|
||
| ## 🌟 Supporting me | ||
|
|
||
| Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on [Twitter](https://twitter.com/lekoarts_de) and share the project with me. | ||
|
|
||
| Please star this project, share it on Social Media or consider supporting me on [GitHub Sponsors](https://github.com/sponsors/LekoArts)! | ||
| ## Made with ❤️ by Lyuboslav Alexandrov |