https://github.com/cloderic/gatsby-starter-portfolio-cara
https://github.com/cloderic/gatsby-starter-portfolio-cara
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cloderic/gatsby-starter-portfolio-cara
- Owner: cloderic
- License: mit
- Created: 2018-12-01T12:33:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-01T12:33:46.000Z (over 7 years ago)
- Last Synced: 2025-01-15T19:44:45.330Z (over 1 year ago)
- Language: JavaScript
- Size: 6.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gatsby Starter Portfolio: Cara
A portfolio starter for [Gatsby](https://www.gatsbyjs.org/). The target audience are designers and photographers.
[Demo Website](https://portfolio-cara.netlify.com/)
[](https://app.netlify.com/start/deploy?repository=https://github.com/LeKoArts/gatsby-starter-portfolio-cara) [](https://codesandbox.io/s/github/LeKoArts/gatsby-starter-portfolio-cara/tree/master/)
- TailwindCSS & Emotion
- React Spring
- Playful & Colorful One-Page website with Parallax effect
Based on [gatsby-tailwind-demo](https://github.com/jlengstorf/gatsby-tailwind-demo).
## Why?
If you want to quickly bootstrap a design/photography portfolio or use it as a foundation for your personal site, the starters in *gatsby-starter-portfolio* are a perfect fit for you! The project's goal is to offer minimalistic and fast websites.
I hope you like my starters and create something awesome! To see some of my work, you can visit my [website](https://www.lekoarts.de) or support me on [Patreon](https://www.patreon.com/lekoarts) to get some neat rewards (4K images, project files, tutorial insights). Every pledge on Patreon helps me create more free starters!
Also, check out the other themes for *gatsby-starter-portfolio*:
- [gatsby-starter-portfolio-emma](https://github.com/LeKoArts/gatsby-starter-portfolio-emma)
- [gatsby-starter-portfolio-emilia](https://github.com/LeKoArts/gatsby-starter-portfolio-emilia)
- [gatsby-starter-portfolio-bella](https://github.com/LeKoArts/gatsby-starter-portfolio-bella)
Check out the [Gatsby Starter Portfolio Overview](https://gatsby-starter-portfolio.netlify.com/)!
## Features
- Gatsby v2.0.0
- [React Spring](https://github.com/drcmda/react-spring) (Used for Parallax effect)
- [TailwindCSS](https://tailwindcss.com/) & [Emotion](https://emotion.sh/) for styling
- Use the full power of TailwindCSS while generating small styles (as unused data gets deleted)
- SEO
- Schema.org JSONLD
- OpenGraph Tags
- Twitter Tags
- [Typefaces](https://github.com/KyleAMathews/typefaces) for quicker font loading
- Offline Support
- WebApp Manifest Support
- Responsive images
- The right image size for every screen size
- Traced SVG Loading (Lazy-Loading)
- WebP Support
**Please note:** The parallax effect can be quite heavy for some older CPUs and the site uses some newer CSS features which will result in incompatibility with older browsers.
## Getting Started
Check your development environment! You'll need [Node.js](https://nodejs.org/en/), the [Gatsby CLI](https://www.gatsbyjs.org/docs/) and [node-gyp](https://github.com/nodejs/node-gyp#installation) installed. The official Gatsby website also lists two articles regarding this topic:
- [Gatsby on Windows](https://www.gatsbyjs.org/docs/gatsby-on-windows/)
- [Check your development environment](https://www.gatsbyjs.org/tutorial/part-zero/)
To copy and install this starter run this command (with "project-name" being the name of your folder you wish to install it in):
```
gatsby new project-name https://github.com/LeKoArts/gatsby-starter-portfolio-cara
cd project-name
npm run dev
```
### Adding new features/plugins
You can add other features by having a look at the official [plugins page](https://www.gatsbyjs.org/docs/plugins/).
### Building your site
```
npm run build
```
Copy the content of the ``public`` folder to your webhost or use a website like Netlify which automates that for you.
Make sure to use the right build command in your build settings e.g. if you use Netlify!
Per default Netlify sets it to `gatsby build` but you have to use `yarn run build` to run postcss before building the Gatsby site.
## Configuration
You have multiple options to configure this project.
1) Use the `config/website.js` to configure data passed to the SEO component and other parts of the Gatsby site:
```JS
module.exports = {
pathPrefix: '/', // Prefix for all links. If you deploy your site to example.com/portfolio your pathPrefix should be "/portfolio"
siteTitle: 'Cara - Gatsby Starter Portfolio', // Navigation and Site Title
siteTitleAlt: 'Cara', // Alternative Site title for SEO
siteUrl: 'https://portfolio-cara.netlify.com', // Domain of your site. No trailing slash!
siteLanguage: 'en', // Language Tag on element
siteLogo: '/logos/logo-1024.png', // Used for SEO and manifest
siteDescription: 'Playful & Colorful One-Page website with Parallax effect',
// siteFBAppID: '123456789', // Facebook App ID - Optional
userTwitter: '@cara', // Twitter Username
ogSiteName: 'cara', // Facebook Site Name
ogLanguage: 'en_US', // Facebook Language
// Manifest and Progress color
themeColor: tailwind.colors.orange,
backgroundColor: tailwind.colors.blue,
};
```
2) Use the `tailwind.js` file to configure TailwindCSS. Their [documentation](https://tailwindcss.com/docs/configuration) explains it step-by-step.
3) Modify the files in the `src/styles` directory.
4) You can also place the icons somewhere else on the page, modify their animation and hide them on smaller screens:
```JSX
```
- For `icon`, you have the options: `triangle, circle, arrowUp, upDown, box, hexa`
- If you want the SVG to be hidden on mobile view, add `className={hidden}` to the SVG component
- You can define the width via the TailwindCSS width [option](https://tailwindcss.com/docs/width)
- The colors get defined via the TailwindCSS color [option](https://tailwindcss.com/docs/colors)
- Please note that you will either have to define the color in `stroke` **or** `fill` depending on the icon. For reference, have a look at the currently used SVGs
- The options `left` and `top` position the icon relatively to its parent container
- You can also wrap the SVGs with `` or `` to animate them
### Typography
Instead of relying on Google's CDN to host its fonts, this site self-hosts the fonts and therefore benefits from increased performance. The installed fonts can be found in `src/pages/index.jsx`:
```JSX
import 'typeface-cantata-one';
import 'typeface-open-sans';
```
This starter uses [typefaces](https://github.com/KyleAMathews/typefaces) by Kyle Mathews. Have a look at the repository if you want to install & use other fonts.
You'll also need to configure `fonts` in `tailwind.js` to reflect the changes. You then can use the fonts with `font-sans` and `font-serif`.