matze177 / drg-api

DRG API is a free API which returns Deep Rock Galactic information and resources.

DRG API

Table of Contents

• About
• Documentation
• Local Development
• Dependencies
• Deployment
• Contributing
• Disclaimer
• Legal

About

DRG API is a free API which returns Deep Rock Galactic information and resources.

Documentation

Documentation using the OpenAPI Specification (OAS) is made available at drgapi.com.

Local Development

In order to run DRG API locally, perform the following steps:

1. Install Python 3
2. Clone this repository:

   git clone https://github.com/MoritzHayden/drg-api.git

3. Navigate to the root directory:

   cd drg-api

4. Execute the run.sh script with the -i and -d flags:

   ./src/scripts/run.sh -i -d

5. Navigate to localhost:8080 in your browser

Dependencies

Dependencies are automatically scanned and updated with Dependabot on a weekly interval, as configured in dependabot.yml. For questions about security, please reference the Security Policy.

Deployment

DRG API is automatically deployed to the DigitalOcean App Platform whenever a push is made to the main branch.

Contributing

Contributions are welcome! If you found a bug or have a request, please open an issue. If you would like to contribute changes, please fork this repository, open a pull request with your changes, and link the PR with an issue. All contributions must adhere to the Code of Conduct. PRs must recieve codeowner approval before they will be merged.

Disclaimer

Neither this project nor its contributors are associated with Deep Rock Galactic or Ghost Ship Games in any way whatsoever.

Legal

• Terms of Service
• Security Policy
• MIT License

Copyright © 2023 Hayden Moritz