diff --git a/README.md b/README.md index 2f81819..fd09406 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,49 @@ -

- - Gatsby - -

-

- Gatsby minimal starter -

- -## πŸš€ Quick start - -1. **Create a Gatsby site.** - - Use the Gatsby CLI to create a new site, specifying the minimal starter. - - ```shell - # create a new Gatsby site using the minimal starter - npm init gatsby - ``` - -2. **Start developing.** +

Portfolio

- Navigate into your new site’s directory and start it up. +## Project Overview πŸŽ‰ +It's my portfolio page made in Gatsby.js. I used this technology because gatsby is a static page generator which was perfect for this project. I organized the structure of the projects, splitting them into assets, components, hooks, templates and pages. On this page you can find information about me You can also send an email directly from the website. This functionality was done using the EmailJS tool. Remember about the correct data in the form as it is validated! - ```shell - cd my-gatsby-site/ - npm run develop - ``` +## Installation πŸ’Ύ +Download the project to your computer and install needed packages with command: +```sh +npm install +``` +Then start the project on the local server with the command: +```sh +npm start +``` +and open http://localhost:8000/ to see this app. -3. **Open the code and start customizing!** +## Live πŸ“ +Link to the live version: https://michalskolak.netlify.app/ - Your site is now running at http://localhost:8000! +## Tech/framework used πŸ”§ - Edit `src/pages/index.js` to see your site update in real-time! +| Tech | Description | +| ------------------------------------------------------- | ---------------------------------------- | +| Gatsby.js | It's a static site generator based on react. | +| Styled-components | Great library for styling components in an application. The biggest advantage of this library is writing styles in js, so we can use conditional statements and other things from javascript there. | +| EmailJS | It's technology for sending e-mails from the website without back-end functions. | +| Formik, Yup | These library help maintain and validate form. | +| Eslint, Prettier | These tools help keep code clean in project. | -4. **Learn more** +## Screenshots πŸ“Ί - - [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter) - - - [Tutorials](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter) - - - [Guides](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter) - - - [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter) +

+ Screenshot +

- - [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter) +

+ Screenshot +

- - [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter) +## Available scripts -## πŸš€ Quick start (Gatsby Cloud) +| Command | Description | +| ------------------------- | ----------------------------- | +| `npm run start` | Open local server | +| `npm run build` | Create optimized build | +| `npm run clean` | Clean .cache folder | -Deploy this starter with one click on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/): -[Deploy to Gatsby Cloud](https://www.gatsbyjs.com/dashboard/deploynow?url=https://github.com/gatsbyjs/gatsby-starter-minimal) +If you encounter a problem, write to this e-mail address: [skolakmichal1@gmail.com](mailto:skolakmichal1@gmail.com)