Giter Club home page Giter Club logo

codeflow's Introduction

Welcome to CodeFlow

๐Ÿ‘‹ Hi there! CodeFlow is a web application that allows developers to post and answer programming-related questions. It is similar to StackOverflow and was developed using Flask, with a MySQL database and SQLAlchemy as the ORM. The application also makes use of Azure services and the flasgger library for Swagger UI documentation.

๐Ÿš€ Getting Started

To get started with CodeFlow, you'll need to have Python 3 and Flask installed on your machine. Follow the instructions on the official Python and Flask websites to install these dependencies.

Once you have these dependencies installed, you can clone the repository to your local machine using the following command:

git clone https://github.com/VitaliySynytskyi/CodeFlow.git

Then, navigate to the project directory and install the remaining dependencies using the following command:

cd CodeFlow 
pip install -r requirements.txt

To start the application, simply run:

python manage.py 
flask run

This will start the development server on http://localhost:5000.

๐Ÿ› ๏ธ Technology Stack

  • Backend: Flask - is a web development framework that allows for easy creation of web applications with Python. Flask-WTF is a Flask extension for working with web forms.
  • Frontend: HTML/CSS, Bootstrap - are used for creating the user interface and styling the web pages.
  • Database: MySQL - is a relational database management system used for storing and retrieving data.
  • ORM: SQLAlchemy - is an Object-Relational Mapping library that provides a way to interact with databases using Python objects.
  • Public API - thecatapi and cat-fact
  • Azure services - refers to cloud computing services provided by Microsoft Azure, which can be used for hosting, storage, and other services.
  • Unit testing framework: Pytest - is a testing framework for Python that allows for easy creation of tests and test suites.
  • Dependency injection: Constructor injection (builtin) - is a design pattern that allows for the injection of dependencies into objects at runtime. In this case, constructor injection is built into the project.
  • Swagger UI: flasgger - is a tool used for generating interactive API documentation from Swagger-compliant API descriptions.
  • Deployment to Azure: Azure Web App service - is a platform-as-a-service (PaaS) offering from Microsoft Azure that allows for deployment and scaling of web applications.

๐Ÿ“ Tasks

The following tasks were completed to develop CodeFlow:

  • Create Solution โœ…
  • Create DB and AppService on Azure โœ…
  • Connect ORM โœ…
  • Create Page About with my information โœ…
  • Create Test Page for Displaying data โœ…
  • Create Test Page for Creating objects โœ…
  • Deploy the project on Azure โœ…
  • Logs โœ…
  • Create Application Insights โœ…
  • Connect Application Insights โœ…
  • Add README on GIT โœ…

๐Ÿ’ฌ Contributing

Contributions to CodeFlow are always welcome! To contribute:

  1. Fork the repository to your own account
  2. Create a new branch from the main branch
  3. Make your changes and push them to your branch
  4. Create a pull request to merge your changes into the main branch
  5. Follow the code style used in the project and write tests for any new functionality you add.

๐Ÿ“ About the Author

Thank you for your interest in CodeFlow! If you have any questions or feedback, feel free to reach out to me via email or Telegram. ๐Ÿ‘

๐Ÿ“’ Lab 3

  • I introduce a new feature that involves creating a blog where the most commonly asked questions will be addressed in an aesthetically pleasing manner.
  • Oleksandr Zhuk
  • My project
  • Pull Request

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.