Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

Latest commit

 

History

History
138 lines (105 loc) · 4.56 KB

README.md

File metadata and controls

138 lines (105 loc) · 4.56 KB

Maintainability Test Coverage


Logo

OverwatchArcade.Today Backend

Discover daily Overwatch arcade gamemodes without having to login to Overwatch.
View website »

View Todo's · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgements

About The Project

Discover daily Overwatch arcade gamemodes without having to login to Overwatch. Daily submittions are posted by contributors (registered members). OverwatchArcade.Today also offers an open API for developers to intergrate in their apps, Discord communities and etc.

Getting Started

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

Prerequisites

  • Discord OAuth2 App (Member registration whitelisting)
  • Twitter OAuth2 App (Twitter posting)
  • APIFlash account needed for (Screenshot service for Tweet media)
  • Dotnet CLI (Run migration)
  • Docker

Installation

  1. Clone the repo 
    git clone https://github.com/OverwatchArcade/Backend.git
  2. Copy appsettings.json to appsettings.(Environment).json 
    cp appsettings.json appsettings.Development.json
  3. Create the hangfire database, the overwatch database can be created automatically by dotnet cli.
  4. Run the dotnet cli database update command. 
    dotnet ef database update
  5. Whitelist your Discord ID in the Whitelist table and visit /login if you wish to login.

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 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 CC BY-NC-SA 4.0 License. See LICENSE for more information.

Acknowledgements