Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator
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, Choose Github Readme Template you want, Fill in the desired fields and press the generate button to create your README.md file)
https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator
List: Awesome-Github-Readme-Generator
eslint-config-next framer-motion git github github-readme mui mui-material next-auth nextjs react react-colorful react-icons react-particles-js recoil tailwind-scrollbar tailwindcss tsparticles typescript
Last synced: 3 months ago
JSON representation
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, Choose Github Readme Template you want, Fill in the desired fields and press the generate button to create your README.md file)
- Host: GitHub
- URL: https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator
- Owner: SashenJayathilaka
- License: apache-2.0
- Created: 2023-04-13T16:06:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-21T00:41:18.000Z (9 months ago)
- Last Synced: 2024-05-22T22:06:16.117Z (6 months ago)
- Topics: eslint-config-next, framer-motion, git, github, github-readme, mui, mui-material, next-auth, nextjs, react, react-colorful, react-icons, react-particles-js, recoil, tailwind-scrollbar, tailwindcss, tsparticles, typescript
- Language: TypeScript
- Homepage: https://genreadme.cloud
- Size: 8.3 MB
- Stars: 129
- Watchers: 3
- Forks: 24
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Awesome Github Readme Generator
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, Choose Github Readme Template you want, Fill in the desired fields, and press the Generate button to create your README.md file)
View Demo
·
Documentation
·
Report Bug
·
Request Feature
### 💻: Support Web Browser
| 
| | | | | |
| ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| 
| 
| 
| 
| 
|
| Edge | Firefox | Chrome | Opera | Brave | Safari |
# :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Features](#dart-features)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Run Locally](#running-run-locally)
- [Roadmap](#compass-roadmap)
- [Contributing](#wave-contributing)
- [Code of Conduct](#scroll-code-of-conduct)
- [License](#warning-license)
- [Contact](#handshake-contact)
## :star2: About the Project
### :camera: Screenshots
- Github Readme File Generator GetStarted
- Fill in the desired fields
- Fill in the desired fields and press the generate button to create your README.md file (& new release)
### :dart: Features
- Github Profile README.md Generator
- Github Repository README.md Generator
### :key: Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`GITHUB_ID`
`GITHUB_SECRET`
`GOOGLE_CLIENT_ID`
`GOOGLE_CLIENT_SECRET`
`NEXT_PUBLIC_SECRET`
`NEXT_PUBLIC_SKILL_API_KEY`
## :toolbox: Getting Started
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator.git
```
Go to the project directory
```bash
cd Github-Readme-File-Generator
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run start
```
## :compass: Roadmap
- [x] Github Profile README.md Generator
- [ ] Github Repository README.md Generator
## :wave: Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
### :scroll: Code of Conduct
Please read the [Code of Conduct](https://github.com/SashenJayathilaka/Github-Readme-File-Generator/blob/main/CODE_OF_CONDUCT.md)
## 💻 Built with
- [Next Js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/): for styling
- [Framer Motion](https://www.framer.com/motion/): for Animations
## 🙇 Special Thanks
- [Anurag Hazra](https://github.com/anuraghazra) for amazing [github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
- [ryo-ma](https://github.com/ryo-ma) for amazing [github-profile-trophy](https://github.com/ryo-ma/github-profile-trophy)
- [Casper](https://github.com/vn7n24fzkq) for amazing [github-profile-summary-cards](https://github.com/vn7n24fzkq/github-profile-summary-cards)
- [Ashutosh Dwivedi](https://github.com/Ashutosh007100) for amazing [github-readme-activity-graph](https://github.com/Ashutosh00710/github-readme-activity-graph)
- [Anton Komarev](https://github.com/antonkomarev) for super cool [github-profile-views-counter](https://github.com/antonkomarev/github-profile-views-counter)
- [Jonah Lawrence](https://github.com/DenverCoder1) for the incredible [github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats)
- [Julien Monty](https://github.com/konpa) for super useful [devicon](https://github.com/konpa/devicon)
## :warning: License
Distributed under the no License. See LICENSE.txt for more information.
## :handshake: Contact
My Name - [Sashen Jayathilaka](https://twitter.com/SashenHasinduJ) - [email protected]
Project Link: [https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator.git](https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator.git)