An open API service indexing awesome lists of open source software.

https://github.com/paralus/website

Paralus website, documentation & blog.
https://github.com/paralus/website

Last synced: 9 months ago
JSON representation

Paralus website, documentation & blog.

Awesome Lists containing this project

README

          

# Paralus Documentation, Blog & Website

This repo contains the [Paralus website](https://paralus.io), documentation, and blog. The website is built using [Docusaurus 2](https://docusaurus.io/), and styled using [Tailwind CSS](https://tailwindcss.com/).

## Prerequisites

To use this repository, you need the following installed locally:

- [npm](https://www.npmjs.com/)

Before you start, install the dependencies. Clone the repository and navigate to the directory:

```bash
git clone ttps://github.com/paralus/website.git
cd website
```

## Development setup

`cd` into your cloned repository, and start the server:

```
$ npm install
$ npm run start
```

You can view the website at [http://localhost:3000](http://localhost:3000). The local site auto-reloads when you make changes.

> Opening a pull request will automatically generate a preview URL. Merging to `main` autodeploys to the [Paralus website](https://paralus.io) using Vercel.

## Contribution

Refer to our [contribution guidelines](/website/CONTRIBUTING.md) to contribute.