Skip to content

Commit

Permalink
Merge pull request #29 from SashenJayathilaka/myNewBranch
Browse files Browse the repository at this point in the history 
🔧 Added Demo File
  • Loading branch information
@SashenJayathilaka
SashenJayathilaka authored Apr 28, 2023
2 parents 18791bd + f9c0f6a commit 424666a
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 184 deletions.
221 changes: 37 additions & 184 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,53 +1,45 @@
<!--
Hey, thanks for using the awesome-readme-template template.
If you have any enhancements, then fork this project and create a pull request
or just open an issue with the label "enhancement".
Don't forget to give this project a star for additional support ;)
Maybe you can mention me or this repo in the acknowledgements too
-->
<div align="center">

<img src="https://user-images.githubusercontent.com/99184393/232021800-8e2d8151-7484-451c-a194-ced6ab249b00.png" alt="logo" width="200" height="auto" />
<img src="https://user-images.githubusercontent.com/99184393/235164394-a1865b60-6506-488a-a666-bd55d2e009cb.png" alt="logo" width="300" height="auto" />
<h1>
Github Readme File Generator.
</h1>

<p>
An awesome README template for your projects!
You can easily and quickly create a readme file for your github profile or git hub repository. (visit below) (Click the Get Started button to start the process, Chose Github Readme Template you want, Fill in the desired fields and press the generate button to create your Readme.Md file,)
</p>


<!-- Badges -->
<p>
<a href="https://github.com/Louis3797/awesome-readme-template/graphs/contributors">
<img src="https://img.shields.io/github/contributors/Louis3797/awesome-readme-template" alt="contributors" />
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/graphs/contributors">
<img src="https://img.shields.io/github/contributors/Louis3797/Github-Readme-File-Generator" alt="contributors" />
</a>
<a href="">
<img src="https://img.shields.io/github/last-commit/Louis3797/awesome-readme-template" alt="last update" />
<img src="https://img.shields.io/github/last-commit/Louis3797/Github-Readme-File-Generator" alt="last update" />
</a>
<a href="https://github.com/Louis3797/awesome-readme-template/network/members">
<img src="https://img.shields.io/github/forks/Louis3797/awesome-readme-template" alt="forks" />
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/network/members">
<img src="https://img.shields.io/github/forks/Louis3797/Github-Readme-File-Generator" alt="forks" />
</a>
<a href="https://github.com/Louis3797/awesome-readme-template/stargazers">
<img src="https://img.shields.io/github/stars/Louis3797/awesome-readme-template" alt="stars" />
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/stargazers">
<img src="https://img.shields.io/github/stars/Louis3797/Github-Readme-File-Generator" alt="stars" />
</a>
<a href="https://github.com/Louis3797/awesome-readme-template/issues/">
<img src="https://img.shields.io/github/issues/Louis3797/awesome-readme-template" alt="open issues" />
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/issues/">
<img src="https://img.shields.io/github/issues/Louis3797/Github-Readme-File-Generator" alt="open issues" />
</a>
<a href="https://github.com/Louis3797/awesome-readme-template/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/Louis3797/awesome-readme-template.svg" alt="license" />
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/Louis3797/awesGithub-Readme-File-Generator" alt="license" />
</a>
</p>

<h4>
<a href="https://github.com/Louis3797/awesome-readme-template/">View Demo</a>
<a href="https://readme-generator-s.vercel.app/">View Demo</a>
<span> · </span>
<a href="https://github.com/Louis3797/awesome-readme-template">Documentation</a>
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/blob/main/README.md">Documentation</a>
<span> · </span>
<a href="https://github.com/Louis3797/awesome-readme-template/issues/">Report Bug</a>
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/issues/">Report Bug</a>
<span> · </span>
<a href="https://github.com/Louis3797/awesome-readme-template/issues/">Request Feature</a>
<a href="https://github.com/SashenJayathilaka/Github-Readme-File-Generator/issues/">Request Feature</a>
</h4>
</div>

Expand All @@ -59,24 +51,15 @@ Github Readme File Generator.

- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Tech Stack](#space_invader-tech-stack)
- [Features](#dart-features)
- [Color Reference](#art-color-reference)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Installation](#gear-installation)
- [Running Tests](#test_tube-running-tests)
- [Run Locally](#running-run-locally)
- [Deployment](#triangular_flag_on_post-deployment)
- [Usage](#eyes-usage)
- [Roadmap](#compass-roadmap)
- [Contributing](#wave-contributing)
- [Code of Conduct](#scroll-code-of-conduct)
- [FAQ](#grey_question-faq)
- [License](#warning-license)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)

<!-- About the Project -->

Expand All @@ -87,120 +70,37 @@ Github Readme File Generator.
### :camera: Screenshots

<div align="center">
<img src="https://placehold.co/600x400?text=Your+Screenshot+here" alt="screenshot" />
<img src="./lib/bin/demo/ezgif-2-fc7c118718.gif" alt="screenshot" />
</div>

<!-- TechStack -->

### :space_invader: Tech Stack

<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.typescriptlang.org/">Typescript</a></li>
<li><a href="https://nextjs.org/">Next.js</a></li>
<li><a href="https://reactjs.org/">React.js</a></li>
<li><a href="https://tailwindcss.com/">TailwindCSS</a></li>
</ul>
</details>

<details>
<summary>Server</summary>
<ul>
<li><a href="https://www.typescriptlang.org/">Typescript</a></li>
<li><a href="https://expressjs.com/">Express.js</a></li>
<li><a href="https://go.dev/">Golang</a></li>
<li><a href="https://nestjs.com/">Nest.js</a></li>
<li><a href="https://socket.io/">SocketIO</a></li>
<li><a href="https://www.prisma.io/">Prisma</a></li>
<li><a href="https://www.apollographql.com/">Apollo</a></li>
<li><a href="https://graphql.org/">GraphQL</a></li>
</ul>
</details>

<details>
<summary>Database</summary>
<ul>
<li><a href="https://www.mysql.com/">MySQL</a></li>
<li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
<li><a href="https://redis.io/">Redis</a></li>
<li><a href="https://neo4j.com/">Neo4j</a></li>
<li><a href="https://www.mongodb.com/">MongoDB</a></li>
</ul>
</details>

<details>
<summary>DevOps</summary>
<ul>
<li><a href="https://www.docker.com/">Docker</a></li>
<li><a href="https://www.jenkins.io/">Jenkins</a></li>
<li><a href="https://circleci.com/">CircleCLI</a></li>
</ul>
</details>

<!-- Features -->

### :dart: Features

- Feature 1
- Feature 2
- Feature 3

<!-- Color Reference -->

### :art: Color Reference

| Color | Hex |
| --------------- | ---------------------------------------------------------------- |
| Primary Color | ![#222831](https://via.placeholder.com/10/222831?text=+) #222831 |
| Secondary Color | ![#393E46](https://via.placeholder.com/10/393E46?text=+) #393E46 |
| Accent Color | ![#00ADB5](https://via.placeholder.com/10/00ADB5?text=+) #00ADB5 |
| Text Color | ![#EEEEEE](https://via.placeholder.com/10/EEEEEE?text=+) #EEEEEE |
- Github Profile Readme.Md Generator
- Github Repository Readme.Md Generator

<!-- Env Variables -->

### :key: Environment Variables

To run this project, you will need to add the following environment variables to your .env file

`API_KEY`

`ANOTHER_API_KEY`

<!-- Getting Started -->

## :toolbox: Getting Started

<!-- Prerequisites -->

### :bangbang: Prerequisites
`GITHUB_ID`

This project uses Yarn as package manager
`GITHUB_SECRET`

```bash
npm install --global yarn
```

<!-- Installation -->
`GOOGLE_CLIENT_ID`

### :gear: Installation
`GOOGLE_CLIENT_SECRET`

Install my-project with npm

```bash
yarn install my-project
cd my-project
```
`NEXT_PUBLIC_SECRET`

<!-- Running Tests -->
`NEXT_PUBLIC_SKILL_API_KEY`

### :test_tube: Running Tests

To run tests, run the following command
<!-- Getting Started -->

```bash
yarn test test
```
## :toolbox: Getting Started

<!-- Run Locally -->

Expand All @@ -209,57 +109,33 @@ To run tests, run the following command
Clone the project

```bash
git clone https://github.com/Louis3797/awesome-readme-template.git
git clone https://github.com/SashenJayathilaka/Github-Readme-File-Generator.git
```

Go to the project directory

```bash
cd my-project
cd Github-Readme-File-Generator
```

Install dependencies

```bash
yarn install
npm install
```

Start the server

```bash
yarn start
```

<!-- Deployment -->

### :triangular_flag_on_post: Deployment

To deploy this project run

```bash
yarn deploy
```

<!-- Usage -->

## :eyes: Usage

Use this space to tell a little more about your project and how it can be used. Show additional screenshots, code samples, demos or link to other resources.

```javascript
import Component from "my-project";

function App() {
return <Component />;
}
npm run start
```

<!-- Roadmap -->

## :compass: Roadmap

- [x] Todo 1
- [ ] Todo 2
- [x] Github Profile Readme.Md Generator
- [ ] Github Repository Readme.Md Generator

<!-- Contributing -->

Expand All @@ -277,19 +153,7 @@ See `contributing.md` for ways to get started.

### :scroll: Code of Conduct

Please read the [Code of Conduct](https://github.com/Louis3797/awesome-readme-template/blob/master/CODE_OF_CONDUCT.md)

<!-- FAQ -->

## :grey_question: FAQ

- Question 1

- Answer 1

- Question 2

- Answer 2
Please read the [Code of Conduct](https://github.com/SashenJayathilaka/Github-Readme-File-Generator/blob/main/CODE_OF_CONDUCT.md)

<!-- License -->

Expand All @@ -301,17 +165,6 @@ Distributed under the no License. See LICENSE.txt for more information.

## :handshake: Contact

Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com

Project Link: [https://github.com/Louis3797/awesome-readme-template](https://github.com/Louis3797/awesome-readme-template)

<!-- Acknowledgments -->

## :gem: Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.
Your Name - [Sashen Jayathilaka](https://twitter.com/SashenHasinduJ) - sashenjayathilaka95@gmail.com

- [Shields.io](https://shields.io/)
- [Awesome README](https://github.com/matiassingers/awesome-readme)
- [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#travel--places)
- [Readme Template](https://github.com/othneildrew/Best-README-Template)
Project Link: [https://github.com/SashenJayathilaka/Github-Readme-File-Generator.git](https://github.com/SashenJayathilaka/Github-Readme-File-Generator.git)
Binary file added lib/bin/demo/ezgif-2-fc7c118718.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 424666a

@vercel
Copy link

@vercel vercel bot commented on 424666a Apr 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

github-readme-generator – ./

readme-generator-s.vercel.app
github-readme-generator-git-main-sashenjayathilaka.vercel.app
github-readme-generator-sashenjayathilaka.vercel.app

Please sign in to comment.