Giter Club home page Giter Club logo

fastapi-template's Introduction

FastAPI App Template

This repository contains a minimal template for FastAPI web applications
Please do note that FastAPI requires Python 3.7 as the minimum version, for any platform.

Deploy


Setting up the environment

To begin coding your application, let's walk you through a few simple steps to set up your environment:

  1. Clone this repository
    ...
    > git clone https://github.com/cobaltgit/fastapi-template.git
    > cd fastapi-template
    ...
    
  2. Create a virtual environment and enter it
    # Unix-like and Linux systems#
    ...
    $ python3 -m venv venv
    $ source venv/bin/activate
    ...
    
    # or for Windows systems...
    ...
    > py -3 -m venv venv
    > venv/Scripts/activate.bat
    ...
  3. Install the required packages
    ...
    > pip install -r requirements.txt
    ...
  4. Happy coding! Feel free to create and modify files within the app directory to create your own API or any other web app!

Running your application

To test your application, you can run the command uvicorn app:app in your terminal or use the start script that is associated with your platform.
Go to the link that appears in the logs (http://127.0.0.1:8000): you should see the base JSON response {response: "Hello World!"}

fastapi-template's People

Contributors

cobaltgit avatar

Watchers

 avatar

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.