https://github.com/arrow-kt/arrow-website

This is the main website for Arrow, the functional companion to Kotlin's Standard Library
https://github.com/arrow-kt/arrow-website

functional-programming hacktoberfest kotlin

Last synced: about 2 months ago
JSON representation

This is the main website for Arrow, the functional companion to Kotlin's Standard Library

• Host: GitHub
• URL: https://github.com/arrow-kt/arrow-website
• Owner: arrow-kt
• License: apache-2.0
• Created: 2022-10-26T08:55:44.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T07:15:09.000Z (8 months ago)
• Last Synced: 2024-05-22T12:05:52.612Z (8 months ago)
• Topics: functional-programming, hacktoberfest, kotlin
• Language: Kotlin
• Homepage: https://arrow-kt.io
• Size: 15.7 MB
• Stars: 10
• Watchers: 13
• Forks: 20
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# arrow-website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Requirements

The site is built through `node` and `npm` (included in Node.js), and the minimum version required for it to work is:

```

"node": ">=16.14"

```

You can check your version by going to your terminal and performing:

```

node -v

```

Depending on your OS and your OS apps/package managers, you could find different methods of having the proper `node` version installed. Please visit the [Node.js website](https://nodejs.org) to see the [best way for you](https://nodejs.org/en/download/) to have it available in your system.

We recommend the use of a tool like [NVM](https://github.com/nvm-sh/nvm) which could ease the installation, and will also allow you to have different `node` versions coexisting in your system in case you need it. Using a LTS Node.js version is recommended.

### Installation

```

$ npm install

```

### Local Development

```

$ npm run start

```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```

$ npm run build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```

$ USE_SSH=true npm run deploy

```

Not using SSH:

```

$ GIT_USER= npm run deploy

```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.