Skip to content

Commit

Permalink
Release: v1.1.0-beta.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Zemerik committed Jan 23, 2025
1 parent a8dffc0 commit 38ed4ec
Show file tree
Hide file tree
Showing 14 changed files with 277 additions and 3 deletions.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/cli.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

name: 🐞 CLI Issue
description: Report an Issue with the CLI
title: '[Bug]: '
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this CLI bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Add descriptions
value: 'Briefly Describe the bug you found'
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots
description: Add screenshots to see the problems
placeholder: Add screenshots
value: 'Add screenshots'
- type: dropdown
id: browsers
attributes:
label: What terminal are you seeing the problem on?
multiple: true
options:
- Git Bash
- Powershell
- Command Prompt
- Windows Terminal
- WSL
- Other
- type: checkboxes
id: self-grab
attributes:
label: Self - Grab
description: By checking this box, you can fix this bug
options:
- label: I would like to work on this issue
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
207 changes: 207 additions & 0 deletions CLI_USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
<p align = "center">

<img src = "public/favicon.ico" style = "height:250px;width:250px">

<br>

<br>

<img src = "https://skillicons.dev/icons?i=javascript,typescript,css,astro,react,vscode,npm,nodejs,php,vue,html,git,vercel,github&perline=25">

</p>

<h1 align = "center">
ZemPosts
</h1>

<p align = "center">
Post & Connect with Developers
</p>

<p align = "center">
<img src = "public/Screenshot.png">
</p
- [Package Link](https://www.npmjs.com/package/zemposts)
> [!Note]
> This CLI tool is currently in Beta. It is not fully complete and may contain bugs or issues. If you encounter any problems or need help, please open an [issue on the repository](https://github.com/Zemerik/ZemPosts). Your feedback is greatly appreciated and will help improve the tool for the final release.
## ⚡ Installation

1. Install the CLI via `NPM`:

```sh
npm i zemposts
```

2. Run the CLI via `NPX`:

```sh
npx zemposts
```

3. Enter your GitHub username when prompted.

![Username](public/images/username.png)

## 💻 Commands:

You will be prompted a number of commands. Use your **Arrow Keys** to navigate between each option, and the **Enter** key to select a specific option. Below is an overview of each command:

<details close>

<summary>
1. Clone Repository:
</summary>

- Command: `👨‍💻 Clone`
- Description: This command allows users to clone either the original ZemPosts repository from GitHub or their forked version. This is useful for users who want to explore and understand ZemPosts.

</details>

<details close>

<summary>
2. Create a New Post:
</summary>

- Command: `📘 New Post`
- Description: Users can create a new blog post either via a local web interface (localhost) or directly in the terminal. This flexibility allows users to choose their preferred method for content creation.

</details>

<details close>

<summary>
3. Run Locally:
</summary>

- Command: `⚡Locally Running`
- Description: This command provides instructions for running the project locally. It checks if the repository is already cloned and, if not, guides the user through the cloning process and sets up the local environment.

</details>

<details close>

<summary>
4. About:
</summary>

- Command: `💁‍♂️ About`
- Description: Displays a brief overview of ZemPosts, including its purpose and key features. This helps users understand what ZemPosts is and what they can do with it.

</details>

<details close>

<summary>
5. Key Features:
</summary>

- Command: `✨ Key Features`
- Description: Lists the key features of ZemPosts, highlighting what makes the platform unique and useful for users.

</details>

<details close>

<summary>
6. Links:
</summary>

- Command: `🌐 Links`
- Description: Provides important links related to ZemPosts, including the GitHub repository, official website, and community support links.

</details>

<details close>

<summary>
7. Exit:
</summary>

- Command: `🔴 Exit`
- Description: Exits the CLI tool. Users can choose this option when they are done using the CLI.

</details>

## 🤝 Cloning:

> [!Caution]
> [Git](https://git-scm.com/) needs to be installed on your device!
You can easily clone either the original ZemPosts Repository or your forked version through our CLI.

1. Select the `👨‍💻 Clone` option and press `Enter`:

![Clone Option](public/images/clone.png)

2. You will now be prompted to clone either the original repository or your forked version. Use your **Arrow Keys** to choose, and press **Enter** to select:

> [!Tip]
> To clone your forked version, you need to first fork a copy of this repository on your github account. Click [here](https://github.com/Zemerik/ZemPosts/fork) to do so.
![Forked/Original](public/images/forked.png)

3. A repository will automatically be cloned.

- If you cloned the original repository, the destination will be `ZemPosts - Zemerik`
- if you cloned your forked version, the destination will be `ZemPosts - [Your Github Username]`

## ➕ Adding your Post:

> [!Caution]
> You must have cloned your forked version of this repository. Refer to `Cloning` section for assistance.
1. Use your arrow keys to select the `📘 New Post` option:

![New Post](public/images/newpost.png)

2. You will then be prompted to either continue in the terminal or open a webpage on localhost. Use your **Arrow Keys** to choose and press **Enter** to select

- You will be asked to enter different information such as your Post Title, and Publication Date. Fill out all the required information as this will be showed on the website!

![Options](public/images/options.png)

3. After you have entered all the required information and submitted, a file would automatically created in the `ZemPosts - [Your Github Username]/src/content/blog` directory with the same title as your post title.

- If necessary, make any changes.

4. After you are happy with your post (remember to check for spelling and grammar mistakes), use `git` to commit and push:

```sh
cd ZemPosts - [Your Github Username]

git add .

git commit -m "New Post: ..."

git push -u origin main
```

5. Open a [Pull-Request](https://github.com/Zemerik/ZemPosts/pulls) on this repository!

> Your PR will be **merged**/**reviewed** as soon as possible!
## 🤖 Other Commands:

- The remaining commands are straightforward and should be easy to use without additional instructions. If you need help with any specific command, please feel free to open an [issue](https://github.com/Zemerik/ZemPosts/issues) for detailed instructions.

## 💁 Support:

For any kind of support or inforrmation, you are free to join our **Discord Server**,

<a href = "https://discord.gg/UF9KsmuGbr">
<img src = "https://invidget.switchblade.xyz/UF9KsmuGbr">
</a>

<h1 align = "center">
Thanks for Visiting🙏
</h1>

<p align = "center">
Don't forget to leave a ⭐
<br>
Made with 💖 by <a href = "https://github.com/Zemerik">Hemang Yadav (Zemerik)</a>
</p>
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<br>

<img src = "https://skillicons.dev/icons?i=javascript,typescript,css,astro,react,vscode,vercel,github&perline=25">
<img src = "https://skillicons.dev/icons?i=javascript,typescript,css,astro,react,vscode,npm,nodejs,php,vue,html,git,vercel,github&perline=25">

</p>

Expand All @@ -24,6 +24,7 @@

- Read our Official Docs on [ZemDocs](https://zemdocs.vercel.app/en/zemposts/introduction)


## 🏃‍♂️ Locally Running:

- This project can be locally executed on your machine in 4 simple steps!
Expand Down Expand Up @@ -59,6 +60,9 @@ npm run astro dev

## ➕ Adding your Post:

> [!Note]
> You can add your Post either manually, or use the CLI. See the [`CLI_USAGE`](https://github.com/Zemerik/ZemPosts/blob/main/CLI_USAGE.md) file for specific instructions.
1. Fork a copy of this Repository on your Github account by clicking below,

- [Fork](https://github.com/Zemerik/ZemPosts/fork)
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Hemang Yadav
Copyright (c) 2025 Hemang Yadav

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<br>

<img src = "https://skillicons.dev/icons?i=javascript,typescript,css,astro,react,vscode,vercel,github&perline=25">
<img src = "https://skillicons.dev/icons?i=javascript,typescript,css,astro,react,vscode,npm,nodejs,php,vue,html,git,vercel,github&perline=25">

</p>

Expand All @@ -28,6 +28,12 @@ ZemPosts stands as an open-source platform, providing users with the opportunity

- Read our Official Docs on [ZemDocs](https://zemdocs.vercel.app/en/zemposts/introduction)

## 🤖 CLI:

ZemPosts has an official CLI that simplifies cloning, contributing, and displaying information. It makes contributing to the repository easier and can display all the information from the README. For more information, refer to the [CLI_USAGE.md](https://github.com/Zemerik/ZemPosts/blob/main/CLI_USAGE.md) file.

- [Package Link](https://www.npmjs.com/package/zemposts)

## 🎥 Youtube Video:

- Feel free to watch our Youtube Video by clicking below 👇
Expand Down
5 changes: 5 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"@astrojs/react": "^3.4.0",
"@astrojs/rss": "^4.0.6",
"@astrojs/sitemap": "^3.1.5",
"@example/basics": "file:",
"@types/react": "^18.3.3",
"@types/react-dom": "^18.3.0",
"astro": "^4.16.18",
Expand Down
Binary file removed public/images/banner.png
Binary file not shown.
Binary file added public/images/clone.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/continue.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/forked.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/newpost.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/options.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/username.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 38ed4ec

Please sign in to comment.