Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 871 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 871 Bytes

How To Contribute

First of all thanks for considering to contribute :)

Setup

Prerequisites

  1. Git
  2. NodeJS (npm comes with it)
  3. NetlifyCLI to test functions.

Project Installation

  1. Clone this repo with git clone https://gitlab.com/thanos.valimitis/to-read.git
  2. Go to toread folder and run npm install
git clone https://gitlab.com/thanos.valimitis/to-read.git
cd toread
npm install

Developing

ToRead App utilizes NetlifyCLI as a local development server that manages the hosting of the web app and the serverless functions together.

  • To start the development server just run ntl dev on the root of the project folder.
  • To build the web app just run npm run build and in the dist folder you will find the output files.