Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/atapas/hobbyland-docz

A project to showcase the usages of docz with gatsbyjs
https://github.com/atapas/hobbyland-docz

docz gatsby react

Last synced: about 1 month ago
JSON representation

A project to showcase the usages of docz with gatsbyjs

Awesome Lists containing this project

README 

        




  

    hobbyland

  





  Hobby Lannd with docz




## 👀 Look at [the Demo](https://hobbyland-docz.vercel.app/)



`Hobby Land` is a place to keep track of your hobbies. Add hobbies that are going well, just started, or need further pushes.



When you add a hobby to the Hobby Land, you provide a rank or weightage. The higher the rank, the better you are doing with the hobby. Lower-ranked hobbies need attention. Hobby Land reminds you that you need to get better at your hobbies.



## 🚀 Quick start



1.  **Clone the repository**



1.  **Start developing.**



    Navigate into your project directory and start it up.



    ```sh

    cd hobbyland-docz

    yarn install

    gatsby develop

    ```



1.  **Open the source code and start editing!**



    Your site is now running at `http://localhost:8000` and your documentation is on `http://localhost:8000/docs`



    _Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._



    Open the `hobbyland-docz` directory in your code editor of choice and edit both `src/pages`, `src/components`.

    Save your changes, add some posts or new documents and the browser will update in real time!



## 🧐 What's inside?



A quick look at the top-level files and directories you'll see in a Gatsby project.



    .

    ├── node_modules

    ├── blog

    ├── src

    ├── .gitignore

    ├── .prettierrc

    ├── gatsby-browser.js

    ├── gatsby-config.js

    ├── gatsby-node.js

    ├── gatsby-ssr.js

    ├── LICENSE

    ├── package-lock.json

    ├── package.json

    └── README.md



1.  **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.



2.  **`/blog`**: This directory will contain all your blog posts writted using [mdx](http://mdxjs.com).



4.  **`/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”.



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



6.  **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.



7.  **`doczrc.js`**: This is the [Docz configuration file](https://www.docz.site/docs/project-configuration). Inside it you will define all configuration related to Docz and how you want to modify it.



8.  **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.



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](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).



10. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.



11. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.



12. **`LICENSE`**: Gatsby is licensed under the MIT license.



13. **`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).**



14. **`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.



15. **`README.md`**: A text file containing useful reference information about your project.



## 🎓 Learning Gatsby and Docz



Looking for more guidance? Full documentation for Docz lives on [the website](http://docz.site) and Gatsby also [on this website](https://www.gatsbyjs.org/). Here are some places to start on Gatsby:



- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/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 our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.



## 💫 Deploy
















# 🤝 Contributing to `hobbyland-docz`

Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.



> Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.



# 🙏 Support



We all need support and motivation. `hobbyland-docz` is not an exception. Please give this project a ⭐️ to encourage and show that you liked it. 



If you found the app helpful, consider supporting me with a coffee.





    




---





A ⭐️ to hobbyland-docz is must.