Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/abdelstark/generator-eip

Ethereum Improvement Proposal generator
https://github.com/abdelstark/generator-eip

blockchain eip ethereum generator npm-package yeoman-generator

Last synced: about 1 month ago
JSON representation

Ethereum Improvement Proposal generator

Host: GitHub
URL: https://github.com/abdelstark/generator-eip
Owner: AbdelStark
License: apache-2.0
Created: 2020-10-22T09:08:50.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2020-10-22T16:24:50.000Z (about 4 years ago)
Last Synced: 2024-10-13T22:20:02.622Z (about 1 month ago)
Topics: blockchain, eip, ethereum, generator, npm-package, yeoman-generator
Language: JavaScript
Homepage:
Size: 2.5 MB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![generator-eip-ci Actions Status](https://github.com/abdelhamidbakhta/generator-eip/workflows/generator-eip-ci/badge.svg)](https://github.com/abdelhamidbakhta/generator-eip/actions)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/abdelhamidbakhta/tx-api-gw/blob/master/LICENSE)

[![sonar-quality-gate][sonar-quality-gate]][sonar-url][![sonar-bugs][sonar-bugs]][sonar-url] [![sonar-vulnerabilities][sonar-vulnerabilities]][sonar-url]

# EIP Generator

![EIP Generator Demo](demo/demo-eip-generator.gif)

## What is it ?

EIP generator is a Yeoman generator to kickstart Ethereum Improvement Proposal.

The EIP process is described at https://eips.ethereum.org/EIPS/eip-1 .

The output files follow the [official EIP template](https://raw.githubusercontent.com/ethereum/EIPs/master/eip-template.md). 

## How to use it ?

### Install Prerequisites

- [npm](https://www.npmjs.com/) package manager

- [yeoman](https://yeoman.io/)

#### Install Yeoman

```shell script

npm install -g yo

```

### Install the generator

### Install from source

```shell script

npm install -g

```

### Install from package manager

```shell script

npm install -g generator-eip

```

### Run the generator

```shell script

yo  eip

```

[sonar-url]: https://sonarcloud.io/dashboard?id=abdelhamidbakhta_generator-eip

[sonar-quality-gate]: https://sonarcloud.io/api/project_badges/measure?project=abdelhamidbakhta_generator-eip&metric=alert_status

[sonar-coverage]: https://sonarcloud.io/api/project_badges/measure?project=abdelhamidbakhta_generator-eip&metric=coverage

[sonar-bugs]: https://sonarcloud.io/api/project_badges/measure?project=abdelhamidbakhta_generator-eip&metric=bugs

[sonar-vulnerabilities]: https://sonarcloud.io/api/project_badges/measure?project=abdelhamidbakhta_generator-eip&metric=vulnerabilities