Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/chornthorn/getx-docs

GetX Library Documentation
https://github.com/chornthorn/getx-docs

dart flutter getx

Last synced: about 2 months ago
JSON representation

GetX Library Documentation

Awesome Lists containing this project

README

        

# 📚 Getx Document

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

### ⚙️ Installation

```
$ npm install
```

### 🧑‍💻 Local Development

```
$ npm 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 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 yarn deploy
```

Not using SSH:

```
$ GIT_USER= yarn 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.