maciejkopec.pl

Hobby project to explore Gatsby's capabilities. My personal simple portfolio static site built with Gatsby

Feel free to use any part from this repository.

🚀 Quick start

1. Clone.

   Clone this repository.

   git clone https://github.com/maciejkopecpl/cms-ui.git
   

2. Build.

   Build the application.

   cd cms-ui/
   yarn install

3. Run

   Now you should be able to run the application.

   gatsby develop

🧐 What's inside?

A quick look at the top-level files and directories.

.
├── src
├── .babelrc
├── .gitignore
├── .prettierignore
├── .prettierrc
├── LICENSE
├── README.md
├── empty.env
├── gatsby-config.js
├── gatsby-node.js
├── package-lock.json
└── package.json

1. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

2. .babelrc: This file contains configuration of Babel

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. .prettierignore: This file tels prettier which files it should ignore.

5. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

6. LICENSE: This project is licensed under the MIT license.

7. README.md: A text file containing useful reference information about your project.

8. empty.env: A empty file containing all requires enviroment variables.

9. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

10. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

11. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

12. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

🏗️ Backend

The backend services required by this application are available in this CMS Backend.

👨‍⚖️ License

MIT