istasyoncikolata

Table of contents

• Getting started
  • Prerequisites
  • Installation
  • Usage
• Contributing
• License
• Maintainers

Getting started

IMPORTANT: The installation guide is only for Linux distributions but you can follow the links for proper installation on your operating system.

Please follow this guide carefully to install kafeasist built with Node to your local machine. This installation guide may differ from OS to OS. So if you use a different OS, please consider reading the installation documentations for your OS from the links given below.

Prerequisites

• Install npm: (guide can be found here)

  sudo apt-get install nodejs npm
  

  Current tested versions can be found in the workflow file.

• (OPTIONAL) Install yarn: (guide can be found here)

  npm install -g yarn
  

Installation

• Clone the repository:

  git clone https://github.com/EgeOnder/istasyoncikolata.git
  

• Install packages:

  With npm: (the guide will be on yarn, if you want to continue using npm, you need to figure out the commands yourself)

  npm install
  

  With yarn: (preferred, guide will contiune with this)

  yarn install
  

• If you want to build the project:

  yarn build
  

Usage

• Run the project in development mode:

  yarn dev
  

• Force lint the code using eslint:

  yarn lint
  

Contributing

Contributions to the project is highly appreciated. If you have any suggestions/questions/requests please consider opening an issue. If you want to contribute to the project, fixing an open issue is greatly recommended and appreciated. To see the all contribution rules please check the contribution rules.

License

This project is licensed under MIT License if you want to see more, please check LICENSE for more information.

Maintainers