Git Product home page Git Product logo

speedwell's Introduction

# Gatsby Simplefolio ⚡️ [![GitHub](https://img.shields.io/github/license/cobidev/gatsby-simplefolio?color=blue)](https://github.com/cobidev/gatsby-simplefolio/blob/master/LICENSE.md) ![GitHub stars](https://img.shields.io/github/stars/cobidev/gatsby-simplefolio) ![GitHub forks](https://img.shields.io/github/forks/cobidev/gatsby-simplefolio) ## A clean, beautiful and responsive portfolio template for Developers

Gatsby Simplefolio

## Features ⚡️ Modern UI Design + Reveal Animations\ ⚡️ One Page Layout built with React\ ⚡️ Styled with Bootstrap v4.3 + Custom SCSS\ ⚡️ Fully Responsive\ ⚡️ Configurable color scheme\ ⚡️ Image optimization with Gatsby\ ⚡️ Easy site customization\ ⚡️ Well organized documentation To view a demo example, **[click here](https://gatsby-simplefolio.netlify.com/)**\ To view a live example, **[click here](https://cobidev.com/)** --- ## Getting Started 🚀 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. ### Prerequisites 📋 You'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [NPM](http://npmjs.com)) installed on your computer.\ Also you need to have installed [Gatsby CLI](https://www.gatsbyjs.org/docs/quick-start/) ``` [email protected] or higher [email protected] or higher [email protected] or higher [email protected] or higher ``` Also, you can use [Yarn](https://yarnpkg.com/) instead of NPM ☝️ ``` [email protected] or higher ``` --- ## How To Use 🔧 From your command line, first clone Simplefolio: ```bash # Clone this repository $ git clone https://github.com/cobidev/gatsby-simplefolio # Go into the repository $ cd gatsby-simplefolio # Remove current origin repository $ git remote remove origin ``` Then you can install the dependencies either using NPM or Yarn: Using NPM: ```bash # Install dependencies $ npm install # Start development server $ gatsby develop ``` Using Yarn: ```bash # Install dependencies $ yarn # Start development server $ gatsby develop ``` **NOTE**: If your run into issues installing the dependencies with NPM, use this command: ```bash # Install dependencies with all permissions $ sudo npm install --unsafe-perm=true --allow-root ``` Once your server has started, go to this url `http://localhost:8000/` and you will see the website running on a Development Server:

Gatsby Simplefolio

--- ## Instructions: ### Step 1 - STRUCTURE Go to `/src/mock/data.js` and fill your information, they are 5 objects: ### Hero Section ```javascript export const heroData = { title: '', // Hello, my name is name: '', // John subtitle: '', // I'm the Unknown Developer. cta: '', // Know more }; ``` ### About Section **_Important Note_**: All the images must live inside the `src/images/` folder in order for Gatsby to show the images correctly. ```javascript export const aboutData = { img: 'profile.jpg', // put your profile image (recommended aspect radio: square) paragraphOne: '', paragraphTwo: '', paragraphThree: '', resume: 'https://www.resumemaker.online/es.php', // if no resume, the button will not show up }; ``` ### Projects Section **_Important Note_**: All the images must live inside the `src/images/` folder in order for Gatsby to show the images correctly. Put as many projects object you want inside the `array`. ```javascript export const projectsData = [ { id: uuidv1(), img: 'project.jpg', title: '', info: '', info2: '', url: '', repo: 'https://github.com/cobidev/react-simplefolio', // if no repo, the button will not show up }, { id: uuidv1(), img: 'project.jpg', title: '', info: '', info2: '', url: '', repo: 'https://github.com/cobidev/react-simplefolio', // if no repo, the button will not show up }, ... ]; ``` ### Contact Section ```javascript export const contactData = { cta: '', // call to action text for the contact section btn: '', // text inside the button email: '', }; ``` ### Footer Section You can remove or add as many you social-media icons you want.\ Just put an object with the corresponding values inside the networks `array` or remove it from there. ```javascript export const footerData = { networks: [ { id: uuidv1(), name: 'twitter', url: '', // your twitter url }, { id: uuidv1(), name: 'codepen', url: '', // your codepen url }, { id: uuidv1(), name: 'linkedin', url: '', // your linkedin url }, { id: uuidv1(), name: 'github', url: '', // your github url }, ], }; ``` ### Required - Disable GitHub buttons Set `isEnabled` to `false` once you finish setup your portfolio.\ By setting to `false` it will hide the GitHub stars/fork buttons ```javascript export const githubButtons = { isEnabled: true, // true is the default value }; ``` ### Step 2 - STYLES Change the color theme of the website ( choose 2 colors to create a gradient ): Go to `src/styles/abstracts/_variables.scss` and only change the values on this classes `$main-color` and `$secondary-color` to your prefered HEX color ```scss // Default values $main-color: #02aab0; $secondary-color: #00cdac; ``` **_Note_**: I highly recommend to checkout gradients variations on [UI Gradient](https://uigradients.com/#BrightVault) --- ## Deployment 📦 Once you have done with your setup. You need to put your website online! I highly recommend to use [Netlify](https://netlify.com) to achieve this on the EASIEST WAY ## Others versions 👥 [Simplefolio](https://github.com/cobidev/simplefolio) by [Jacobo Martinez](https://github.com/cobidev)\ [Ember.js Simplefolio](https://github.com/sernadesigns/simplefolio-ember) by [Michael Serna](https://github.com/sernadesigns) ## Technologies used 🛠️ - [Gatsby](https://www.gatsbyjs.org/) - Static Site Generator - [GraphQL](https://graphql.org/) - Query language for APIs - [React](https://es.reactjs.org/) - Front-End JavaScript library - [Bootstrap 4](https://getbootstrap.com/docs/4.3/getting-started/introduction/) - Front-End UI library - [Sass](https://sass-lang.com/documentation) - CSS extension language ## Authors - **Jacobo Martinez** - [https://github.com/cobidev](https://github.com/cobidev) ## Status [![Netlify Status](https://api.netlify.com/api/v1/badges/2365af6f-820a-4fb8-83e6-69a66f686dfe/deploy-status)](https://app.netlify.com/sites/gatsby-simplefolio/deploys) ## License 📄 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details ## Acknowledgments 🎁 I was motivated to create this project because I wanted to contribute on something useful for the dev community, thanks to [ZTM Community](https://github.com/zero-to-mastery) and [Andrei](https://github.com/aneagoie) # shail2512

speedwell's People

Contributors

shail2512 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.