README.md

cryptoterminal.eu

This repository contains the source files and build scripts for the CryptoTerminal website.

• Requirements
• Getting Started
• How to Update the Website

Requirements

The following is a list of requirements needed to contribute to this project.

• nodejs - For Linux and Mac install node via nvm.
• make

Getting Started

Before continuing, be sure to download and install the project requirements.

Get the code:

git clone [email protected]:samotari/cryptoterminal.eu.git

Install dependencies:

cd cryptoterminal.eu
npm install

To build and serve the homepage locally:

npm run build && npm run server

Then open your browser to localhost:3000.

How to Update the Website

The homepage is hosted via GitHub pages. The docs directory in this repository contains the web files that are served to visitors of cryptoterminal.eu.

To create a new commit of the latest build:

npm run commit

• Write a message that summarizes the changes made.
• Open a pull-request to the upstream master branch.
• Once merged, the changes should be visible within a few minutes.

License

This project is licensed under the GNU Affero General Public License v3 (AGPL-3.0).