Skip to content

Commit de236f3

Browse files
holgerd77holgerd77
authored
Merge pull request #4 from ethereumjs/update-website
Update website
2 parents 686df01 + 15f91cb commit de236f3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+8982
-63
lines changed

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
_site
2+
.sass-cache
3+
.jekyll-metadata
4+
Gemfile.lock

‎Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'https://rubygems.org'
2+
gem 'github-pages', group: :jekyll_plugins

‎README.md

Lines changed: 58 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,58 @@
1-
This is a collection of libraries and utilities for [Ethereum](https://ethereum.org).
2-
3-
## Use cases
4-
5-
### Creating an online wallet?
6-
7-
Check out [keythereum](https://github.com/ethereumjs/keythereum) or [ethereumjs-wallet](https://github.com/ethereumjs/ethereumjs-wallet) (with HD wallet support) for managing keys and [ethereumjs-tx](https://github.com/ethereumjs/ethereumjs-tx) for creating transactions with them.
8-
[ethereumjs-icap](https://github.com/ethereumjs/ethereumjs-icap) might also come handy for dealing with the ICAP (Ethereum in IBAN) format.
9-
10-
### Creating a Dapp?
11-
12-
You will need to interface with the Ethereum network. [web3.js](https://github.com/ethereum/web3.js) provides a complete Javascript API to interact with the RPC interface. If looking for a more lightweight option, [ethereumjs-abi](https://github.com/ethereumjs/ethereumjs-abi) or [solidity.js](https://github.com/ethereumjs/solidity.js) can handle the ABI encoding.
13-
14-
### Interested in running a node?
15-
16-
See [node-blockchain-server](https://github.com/ethereumjs/node-blockchain-server). It is in a pretty rough state at the moment, but at least can download the blockchain.
17-
18-
## Full list of repos
19-
20-
* [browser-builds](https://github.com/ethereumjs/browser-builds): browser builds of ethereumjs libraries
21-
* [common](https://github.com/ethereumjs/common): the genesis data for the blockchain
22-
* [ethashjs](https://github.com/ethereumjs/ethashjs): [Ethash](https://github.com/ethereum/wiki/wiki/Ethash) in Javascript
23-
* [ethereumjs-abi](https://github.com/ethereumjs/ethereumjs-abi): ABI encoding and decoding
24-
* [ethereumjs-account](https://github.com/ethereumjs/ethereumjs-account): account schema encoding, decoding and validation
25-
* [ethereumjs-block](https://github.com/ethereumjs/ethereumjs-block): block schema encoding, decoding and validation
26-
* [ethereumjs-blockchain](https://github.com/ethereumjs/ethereumjs-blockchain): manage a blockchain
27-
* [ethereumjs-codesim](https://github.com/axic/ethereumjs-codesim): run EVM or Solidity code and examine the output
28-
* [ethereumjs-icap](https://github.com/ethereumjs/ethreumjs-icap): utilities for handling ICAP (Ethereum in IBAN) encoding
29-
* [ethereumjs-lib](https://github.com/ethereumjs/ethereumjs-lib): meta package for loading the other ethereumjs- modules
30-
* [ethereumjs-testing](https://github.com/ethereumjs/ethereumjs-testing): transforms the [official test vectors](https://github.com/ethereum/tests) to a format suitable for ethereumjs
31-
* [ethereumjs-tx](https://github.com/ethereumjs/ethereumjs-tx): transaction creation, manipulation, signing and verification
32-
* [ethereumjs-units](https://github.com/ethereumjs/ethereumjs-units): Ethereum unit conversion
33-
* [ethereumjs-util](https://github.com/ethereumjs/ethereumjs-util): a collection of frequently used methods by the other libraries
34-
* [ethereumjs-wallet](https://github.com/ethereumjs/ethereumjs-wallet): lightweight toolkit for managing Ethereum keys, including HD wallet support
35-
* [ethereumjs-vm](https://github.com/ethereumjs/ethereumjs-vm): a complete EVM (Ethereum Virtual Machine) and state processing implementation
36-
* [geth.js](https://github.com/ethereumjs/geth.js): start and stop geth from Node.js
37-
* [helpeth](https://github.com/ethereumjs/helpeth): purists' commandline tool for key and transaction management
38-
* [keythereum](https://github.com/ethereumjs/keythereum): create, import and export Ethereum keys
39-
* [merkle-patricia-tree](https://github.com/ethereumjs/merkle-patricia-tree): This is an implementation of the modified merkle patricia tree as specified in the [Ethereum yellow paper](http://gavwood.com/Paper.pdf)
40-
* [node-blockchain-server](https://github.com/ethereumjs/node-blockchain-server): aims to provide a full Ethereum node implementation
41-
* [node-devp2p](https://github.com/ethereumjs/node-devp2p): implementation of the [RLPx](https://github.com/ethereum/devp2p/blob/master/rlpx.md) transport protocol for Ethereum (used between nodes)
42-
* [node-devp2p-dpt](https://github.com/ethereumjs/node-devp2p-dpt): implementation of the [RLPx](https://github.com/ethereum/devp2p/blob/master/rlpx.md) DPT (peer table) protocol for Ethereum
43-
* [node-devp2p-eth](https://github.com/ethereumjs/node-devp2p-eth): implementation of the Ethereum sub-protocol over RLPx
44-
* [node-devp2p-manager](https://github.com/ethereumjs/node-devp2p-manager): peer manager for DPT & RLPx
45-
* [organization](https://github.com/ethereumjs/organization) and [ideas](https://github.com/ethereumjs/ideas): plans and discussions
46-
* [rlp](https://github.com/ethereumjs/rlp): [RLP (Recursive Length Prefix)](https://github.com/ethereum/wiki/wiki/RLP) encoding and decoding
47-
* [testrpc](https://github.com/ethereumjs/testrpc): fast Ethereum RPC node for testing and development
48-
49-
50-
## Ethereum JS projects not tracked here
51-
* [web3.js](https://github.com/ethereum/web3.js): the complete API as seen in the [wiki](https://github.com/ethereum/wiki/wiki/JavaScript-API)
52-
* [solidity.js](https://github.com/ethereum/solidity.js): ABI encoding and decoding (the relevant code split out from web3.js)
53-
54-
## Contributing and contact
55-
56-
Please check out [organization](https://github.com/ethereumjs/organization) and [ideas](https://github.com/ethereumjs/ideas) repos first. Contributing to each of the projects is preferably done via pull requests.
57-
58-
You can also reach out on:
59-
* [Gitter](https://gitter.im/ethereum/ethereumjs-lib)
60-
* [#ethereumjs](https://webchat.freenode.net/?channels=ethereumjs) on freenode
1+
# SYNOPSIS
2+
3+
[![Gitter](https://img.shields.io/gitter/room/ethereum/ethereumjs-lib.svg?style=flat-square)](https://gitter.im/ethereum/ethereumjs-lib) or #ethereumjs on freenode
4+
5+
# INTRODUCTION
6+
7+
Website to give an overview of the various ``EthereumJS`` projects and an
8+
introduction to the ecosystem and the community.
9+
10+
Site is hosted at https://ethereumjs.github.io/ via [GitHub Pages](https://pages.github.com) and
11+
build with [Jekyll](https://jekyllrb.com/) (see also ["Jekyll and GH Pages"](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/)).
12+
13+
It uses the [Cayman](https://github.com/jasonlong/cayman-theme) theme available as an option on GitHub.
14+
15+
# SITE UPDATES
16+
17+
You can update the site by editing the markdown in [./index.md](./index.md) (via PR), build will be
18+
triggered automatically on merge.
19+
20+
For information on repository metadata on GitHub pages see [this](https://help.github.com/articles/repository-metadata-on-github-pages/) article.
21+
22+
Custom CSS can be added in [./assets/css/style.scss](./assets/css/style.scss).
23+
24+
# LIBRARY INCLUDES
25+
26+
The website uses [Font Awesome](http://fontawesome.io/) ``v4.7.x`` for some icons. To update the library
27+
download the latest release from the website and replace the un-versioned ``font-awesome`` folder in the
28+
``assets/`` folder.
29+
30+
In ``scss/_variables.scss`` update the ``$fa-font-path`` to point to the ``../font-awesome/fonts`` directory.
31+
32+
33+
# LOCAL BUILD
34+
35+
To build the site locally you have to have a working [Ruby](https://www.ruby-lang.org) ``2.4.x`` environment (you can use the [RVM](https://rvm.io/) Ruby version manager for this) and ``bundle`` and ``Jekyll`` installed.
36+
37+
Install the ``GitHub pages`` gem from the ``Gemfile`` with:
38+
39+
```
40+
bundle install
41+
```
42+
43+
See also [this article](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/) for further installation instructions.
44+
45+
The site can then be build with:
46+
47+
```
48+
jekyll build
49+
```
50+
51+
And being served on http://127.0.0.1:4000 with:
52+
53+
```
54+
jekyll serve
55+
```
56+
57+
58+

‎_config.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
title: ethereumjs
2-
description: Your Javascript gateway to Ethereum
1+
title: EthereumJS
2+
description: Your Javascript Gateway to Ethereum
3+
repository: ethereumjs
34
google_analytics:
45
show_downloads: true
56
theme: jekyll-theme-cayman
67

78
gems:
89
- jekyll-mentions
10+
- jekyll-github-metadata
11+
12+
sass:
13+
load_paths:
14+
- assets/css # original sass
15+
16+

‎_includes/repository.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{% for repository in site.github.public_repositories %}
2+
{% if repository.name == include.name %}
3+
<pre id="github-pages-metadata" style="display:none;"></pre>
4+
<script>document.getElementById("github-pages-metadata").innerHTML = JSON.stringify({{ repository | jsonify }}, null, 4);</script>
5+
<div class="repo-box">
6+
<div class="repo-header">
7+
<div class="repo-header-right">
8+
{{ repository.stargazers_count }} <i class="fa fa-star"></i>&nbsp;&nbsp;
9+
10+
<a href="{{ repository.html_url }}" alt="GitHub URL">
11+
<i class="fa fa-github"></i>
12+
</a>
13+
</div>
14+
{{ repository.name }}
15+
</div>
16+
<div class="repo-description">
17+
{{ repository.owner_name }}
18+
{{ repository.description }}
19+
</div>
20+
</div>
21+
22+
23+
24+
25+
{% endif %}
26+
{% endfor %}

‎assets/css/style.scss

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
---
3+
4+
@import "{{ site.theme }}";
5+
@import "../font-awesome/scss/font-awesome";
6+
7+
h1 {
8+
margin-bottom: 25px !important;
9+
}
10+
11+
.page-header a {
12+
display: none;
13+
}
14+
15+
.intro-text {
16+
background-color: #caefdc;
17+
padding: 20px;
18+
font-size: 1.2rem;
19+
text-align: center;
20+
}
21+
22+
.repo-group {
23+
width: 100%;
24+
float: left;
25+
}
26+
27+
@media only screen and (min-width: 650px) {
28+
.repo-group {
29+
width: 47%;
30+
padding-right: 3%;
31+
}
32+
}
33+
34+
.repo-group h3 {
35+
border-bottom: 1px solid #159957;
36+
}
37+
38+
.repo-group p {
39+
margin-bottom: 22px;
40+
}
41+
42+
.repo-group .repo-box {
43+
margin-bottom: 15px;
44+
}
45+
46+
.repo-group .repo-header {
47+
background-color: #018372;
48+
padding: 5px 8px 5px 8px;
49+
color: #fff;
50+
}
51+
52+
.repo-group .repo-header a {
53+
color: #fff;
54+
}
55+
56+
.repo-group .repo-header-right {
57+
float: right;
58+
}
59+
60+
.repo-group ul {
61+
font-size: 0.94rem;
62+
}
63+
64+
.repo-group .repo-description {
65+
border: 1px solid #018372;
66+
padding: 5px 8px 5px 8px;
67+
font-size: 0.9rem;
68+
min-height: 75px;
69+
}
70+
71+
.separator {
72+
clear: both;
73+
height: 35px;
74+
}
75+
76+
.attribution {
77+
margin-top: 40px;
78+
font-size: 0.9rem;
79+
}

‎assets/font-awesome/HELP-US-OUT.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
I hope you love Font Awesome. If you've found it useful, please do me a favor and check out my latest project,
2+
Fort Awesome (https://fortawesome.com). It makes it easy to put the perfect icons on your website. Choose from our awesome,
3+
comprehensive icon sets or copy and paste your own.
4+
5+
Please. Check it out.
6+
7+
-Dave Gandy

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy