/fictadvisor-bot

Telegram bot for fictadvisor.com

Primary LanguagePythonMIT LicenseMIT

Logo

BOT

Bot application for fictadvisor.com
Explore the docs »

View the Website · Report a Bug · Request a Feature

Table of contents
  1. About the project
  2. Getting started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About the project

This application provides a Telegram Bot application for FICT Advisor.

Built with

Getting started

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

Prerequisites

  • Python
  • pip
  • Poetry (pip install poetry)

Installation

ALL FOLLOWED COMMANDS MUST BE USED IN PROJECT DIRECTORY

  1. Clone the repository 
    git clone https://github.com/fictadvisor/fictadvisor-bot.git
  2. Install python packages 
    poetry install
  3. PM Team-Lead to receive .env configuration.

Usage

To start the application:

  • If you use PyCharm:

    uvicorn app.main:app --reload

  • If you use VS Code:

    1. Activate poetry shell
    poetry shell
    1. Start the application:
    uvicorn app.main:app --reload

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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

  1. Fork the project
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Added an amazing feature')
  4. Push the branch (git push -u origin feature/amazing-feature)
  5. Open a pull request

License

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

Contact

Feedback - https://t.me/fict_robot Project - https://github.com/fictadvisor

Acknowledgements