Skip to content

A REST API for getting current information on mma athletes.

License

Notifications You must be signed in to change notification settings

danetsao/mma-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MMA API 🥋 🥊

A REST API for getting current information on mma athletes.

Explore the docs »

Try it yourself · Report Bug · Request Feature

Table of Contents
  1. Overview
  2. Scraping
  3. Getting Started
  4. Contributing
  5. License
  6. Acknowledgments

Overview

This is an MMA API that scraped data from ufc.com, stores it in a Postgres database, and has a node + express api to give information on the athletes.

A supplemental mma-scraping repository is used to configre the database and can be used for much more.

Scraping

See mma-scraping to get started scraping mma data.

You can use this repo to config the database used in this api.

Getting Started

Prerequisites

prereqs

Environment Variables

For specific functionly, you will need to add the following environment variables to your .env file

To store scraped information to database (needed to run api locally)

PostgreSQL Database

DB_HOST

DB_PORT

DB_NAME

DB_USER

DB_PASSWORD

If you need help configuring a PostgreSQL database, see documentation

Installations

installations

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

⬆️ Back to Top ⬆️

About

A REST API for getting current information on mma athletes.

Topics

Resources

License

Stars

Watchers

Forks