FLock.io App

An app to access the FLock.io platform


Report Bug · Request Feature

Table of Contents

1. About The Project
   • System Design
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• node
• npm
• yarn

Installation

1. Clone the repo

   git clone https://github.com/flock-io/interface.git

2. Install NPM packages

   yarn install

3. Copy .env.example into .env

(back to top)

Usage

1. Start in developing mode

   yarn dev

2. Go to http://localhost:3000

(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.txt for more information.

(back to top)

Contact

Rodrigo Pavezi - @rodrigopavezi - [email protected]

Project Link: https://github.com/flock-io/interface

(back to top)