flexie-api

Flexie Api

Advanced API module for your projects,
Explore the docs »

Report Bug · Request Feature

Table of Contents

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

Built With

This section lists the main frameworks we created using our project.

• Http
• Events
• Typescript

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You must download nodejs to use this software.

https://nodejs.org/en/download/current/

Installation

1. İnstall the package

   npm install flexie-api

2. İmport your index file

   const FlexieApi = require('flexie-api')

3. And one last step for you to use our package. Add this to your code.

    const flexie = new Flexie({
      json: true, //json not used yet
      logger: true // logger true & false
    }, 3000)// port

Usage

For more examples, please refer to the Documentation

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.

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

License

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

Contact

Your Name - Discord - flexie-api.js.org

Project Link: https://github.com/FlexieTeam/flexie-api