Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting started docs 1 #77

Merged
merged 8 commits into from
Mar 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 61 additions & 17 deletions docs/guides/starting-contribution/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,74 @@
title: Getting Started
---

# Dummy
## Add your profile

Dummy is a content generation toolkit designed to make the development, testing and presentation of web prototypes less time consuming and more realistic. It does so by making it easy to populate static HTML with dynamic content, and by randomizing elements within a layout on subsequent loads of a document, in a way, simulating connectivity to a live database.
There are 2 ways you can add your profile :

Originally conceived as a tool for helping to simulate the high volume, rapidly changing content characteristics of online newspapers and magazines, it's generalized enough to benefit the early stage front-end development of any website or application with content that frequently changes in length, form or nature.
1. Directly from the GitHub
2. Using a code editor (eg. VSCode)

Dummy can be useful in the early stages of a project's development, where basic questions and assumptions about how to architect the front-end must be tested and resolved to conclusion before engineers further down the Gantt diagram can begin their work of obfuscating yours.
## Step 1:

It can also been seen as a support tool for designers and front-end artisans ready to embrace the dark art of designing in-browser, as vastly different layout permutations can be generated and evaluated rapidly with each load of the page. Problems and shortcommings can be more quickly exposed.
### 1. Visit the <Link href="https://github.com/pbclife/gitopener.vercel.app">GitOpener repo</Link>

### Dummy can…
![repo](https://user-images.githubusercontent.com/95094057/218765545-f6586a18-c194-42d5-a5aa-45cf42e5b5ee.png)

- Insert randomly selected strings of placeholder text in various lengths and formats (e.g. headline, teaser, paragraph).
- Automagically crop and size high quality, news worthy, Creative Commons licensed placeholder images from a default pool – or from a specific folder or subset of folders that you provide.
- Flesh out highly variable, asset rich layouts quickly with friendly, human-readable logic for building loops and controlling probability.
- Allow you to focus on the important things – namely, the design and the code – not on copying and pasting (static) Lorem Ipsum, or hunting down plausible placeholder images.
- More. Not lots more, but a _bit_ more!
### 2. Fork the repo into your account

### You can…
![fork](https://user-images.githubusercontent.com/95094057/218765603-c65a2a08-b234-4c5f-871f-c6e8a73fe299.png)

- Watch a screencast at https://vimeo.com/42252088
- Ask questions and direct misgivings to http://twitter.com/kerns
- Fork, follow or download via https://github.com/kerns/dummy
### 3. Click add file and select "create new file"

### More Info
![addFile](https://user-images.githubusercontent.com/95094057/218765622-86d41908-343d-403f-891e-4a8e0b035ce3.png)

Dummy's primary goal is to provide tools that speed front-end prototyping and QA. Whether you're meticulously crafting a fully responsive site with a myriad of CSS breakpoints, or just slapping together a half-baked idea – using Dummy should make it easier _at the earliest stages of development_ to visualize, test and present something much closer to what your actual front-end will become under a variety of different conditions.
### 4. Create your file named `contribution/<Your GitHub username>`, and append `.mdx` (for example `contribution/Aadarsh805.mdx`)

![createProfile](https://user-images.githubusercontent.com/95094057/218765648-f408a8f0-efa3-4c81-97c9-810db37f7235.png)

### 5. For the content use the mdx structure below:
```
---
author: Aadarsh Thakur
github_username: Aadarsh805
occupation: Student
---

# Introduction

Hi I'm Aadarsh Thakur, a frotend developer from Indore, India. I am currently a 3rd year Computer Science student persuing B-Tech.
I love building cool projects, contributing to OpenSource and getting involved in awesome tech communities.

## Skills

<Skills>
<Skill
name="Next Js"
icon={/* svg icon for nextJS */}
>
NextJS
</Skill>
<Skill
name="Typescript"
icon={/* svg icon for Typescript */}
>
Typescript
</Skill>
</Skills>
```

### 6. Add Projects

<!-- -->

### 7. Click `Create pull request`

### 8. Now you need to wait to have your Pull Request reviewed

## Example Profiles

Looking for inspiration? You can view the following profiles for an example:

- ![Sagar Bera](https://gitopener.vercel.app/contribution/sboy99)

- ![Aadarsh Thakur](https://gitopener.vercel.app/contribution/Aadarsh805)
Binary file added public/images/getting-started/addFile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/getting-started/createProfile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/getting-started/fork.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/getting-started/repo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.