Skip to content

whenson9086/service

 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License

Service

Backend for ScoreTracker.
Explore the docs »

· Report Bug · Request 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

Back end API for ScoreTracker app.

Built With

  • Code style: black

Getting Started

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

Installation

  1. Clone the repo

    git clone https://github.com/fohs-score-tracker/service.git
    
  2. Change directory to service

    cd service
    
  3. Install Python dependencies

    pip install -r requirements.txt
    
  4. Environment variables are used for configuration (which can also be set in .env)

    Example config file:

    REDIS_URL="redis://user:password@server/db"

    ℹ The database provided by the REDIS_URL variable is not used for testing.

Usage

uvicorn scoretracker:app

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 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 https://mit-license.org/ for more information.

Contact

Project Link: https://github.com/fohs-score-tracker/service

Acknowledgements / Thanks

About

Back end / service layer / Flask

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.8%
  • Shell 0.2%