Skip to content

Commit e026cca

Browse files
committed
Update README and add contribution guideline
1 parent b6db1e9 commit e026cca

File tree

2 files changed

+82
-79
lines changed

2 files changed

+82
-79
lines changed

CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing
2+
3+
Any contribution is welcome.
4+
5+
To avoid reliance on third party services, this project will require community support to extend and maintain the list of tracked token backings.
6+
7+
For the most part this only requires adding or updating data files.
8+
9+
If you want to contribute on the functionality of the webpage itself, you can fork the repository and propose changes through pull requests. The webpage is build using Svelte and development is done using NPM.
10+
11+
## How do I get set up?
12+
13+
### Install nvm
14+
15+
For the package management, we need to install Node. To install a specific version of Node, we will first install the [Node Version Management (nvm)](https://github.com/nvm-sh/nvm).
16+
17+
Download and install nvm:
18+
19+
```shell
20+
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
21+
```
22+
23+
Reload the .bashrc:
24+
25+
```shell
26+
source ~/.bashrc
27+
```
28+
29+
### Install Node
30+
31+
You should now be able to list all available Node versions like this (``--lts`` for versions with long term support):
32+
33+
```shell
34+
nvm list-remote --lts
35+
```
36+
37+
You can find some information about the major versions and their long term support on the [release page of Node.js](https://nodejs.org/en/about/releases/).
38+
39+
You can install the latest v16 version with long term support with this command:
40+
41+
```shell
42+
nvm install v16 --lts
43+
```
44+
45+
Switch to the project folder and install the dependencies.
46+
47+
```shell
48+
cd portal
49+
npm install
50+
```
51+
52+
## How to locally serve the page?
53+
54+
To see if everything is working you can start it up like that.
55+
56+
```shell
57+
npm run dev -- --open
58+
```
59+
60+
If everything worked correct, your browser should open `http://localhost:3000/`.
61+
62+
You can also use the VS code launch configuration `Debug Svelte App` via `F5` to debug the application.
63+
64+
## How do I run tests?
65+
66+
Execute:
67+
68+
```shell
69+
npm test
70+
```
71+
72+
## Building
73+
74+
To create a production version of your app:
75+
76+
```bash
77+
npm run build
78+
```

README.md

+4-79
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<p align="center">Asset backing visualized.</p>
66

7-
<p align="center"><em>Check it out at <a href="https://spenhouet.com/bcked/">spenhouet.com/bcked</a>.</em></p>
7+
<p align="center"><em>Check it out at <a href="https://bcked.com/">bcked.com</a>.</em></p>
88

99
## Features
1010

@@ -15,85 +15,10 @@ TBD
1515
By no means should the provided data be used to make financial decisions.
1616
The shown data can be wrong, biased, or simply outdated.
1717

18-
## Contribution
18+
## Contributing
1919

20-
Any contribution is welcome.
21-
22-
To avoid reliance on third party services, this project will require community support to extend and maintain the list of tracked token backings.
23-
24-
For the most part this only requires adding or updating data files.
25-
26-
If you want to contribute on the functionality of the webpage itself, you can fork the repository and propose changes through pull requests. The webpage is build using Svelte and development is done using NPM.
27-
28-
### How do I get set up?
29-
30-
#### Install nvm
31-
32-
For the package management, we need to install Node. To install a specific version of Node, we will first install the [Node Version Management (nvm)](https://github.com/nvm-sh/nvm).
33-
34-
Download and install nvm:
35-
36-
```shell
37-
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
38-
```
39-
40-
Reload the .bashrc:
41-
42-
```shell
43-
source ~/.bashrc
44-
```
45-
46-
#### Install Node
47-
48-
You should now be able to list all available Node versions like this (``--lts`` for versions with long term support):
49-
50-
```shell
51-
nvm list-remote --lts
52-
```
53-
54-
You can find some information about the major versions and their long term support on the [release page of Node.js](https://nodejs.org/en/about/releases/).
55-
56-
You can install the latest v16 version with long term support with this command:
57-
58-
```shell
59-
nvm install v16 --lts
60-
```
61-
62-
Switch to the project folder and install the dependencies.
63-
64-
```shell
65-
cd portal
66-
npm install
67-
```
68-
69-
### How to locally serve the page?
70-
71-
To see if everything is working you can start it up like that.
72-
73-
```shell
74-
npm run dev -- --open
75-
```
76-
77-
If everything worked correct, your browser should open `http://localhost:3000/`.
78-
79-
You can also use the VS code launch configuration `Debug Svelte App` via `F5` to debug the application.
80-
81-
### How do I run tests?
82-
83-
Execute:
84-
85-
```shell
86-
npm test
87-
```
88-
89-
### Building
90-
91-
To create a production version of your app:
92-
93-
```bash
94-
npm run build
95-
```
20+
If you would like to contribute, please read [our contribution guideline](CONTRIBUTING).
9621

9722
## License
9823

99-
This tool is an open source community project released under the [GNU General Public License, Version 3](LICENSE).
24+
This tool is an open source community project released under the [GNU General Public License, Version 3](LICENSE).

0 commit comments

Comments
 (0)