Skip to content

README.md

Latest commit

 

History

History
115 lines (89 loc) · 3.12 KB

README.md

File metadata and controls

115 lines (89 loc) · 3.12 KB

Flow OS

The customizable webOS.
Explore the wiki »

Try it Out · Report Bug · Request Feature

Table of Contents
  1. Built With
  2. Getting Started
  3. Contributing
  4. License
  5. Contact

Built With

Here are some libraries used to create FlowOS.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • yarn 
    npm install yarn@latest -g

Installation

  1. Get a free API Key at https://example.com

  2. Clone the repo

    git clone https://github.com/Flow-Works/FlowOS

  3. Install NPM packages

    yarn install

  4. Enter your KEY, IV, SECRET in .env

    # SHA-256 SALT
SALT=anything-can-go-here

# COOKIE SECRET
SECRET=anything-can-go-here

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Twitter: @_heyflow

Email: [email protected]

(back to top)