|
4 | 4 |
|
5 | 5 | <p align="center">Asset backing visualized.</p>
|
6 | 6 |
|
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> |
8 | 8 |
|
9 | 9 | ## Features
|
10 | 10 |
|
|
15 | 15 | By no means should the provided data be used to make financial decisions.
|
16 | 16 | The shown data can be wrong, biased, or simply outdated.
|
17 | 17 |
|
18 |
| -## Contribution |
| 18 | +## Contributing |
19 | 19 |
|
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). |
96 | 21 |
|
97 | 22 | ## License
|
98 | 23 |
|
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