Giter VIP home page Giter VIP logo

octagon-api's Introduction

Welcome to Octagon API 🥊

🚦 Lighthouse Score

performance accessibility seo best-practices

📜 Description

This is an open source project, created by a group of developers who love MMA.

Our purpose is to provide a free and fast API from this popular sport. There were lots of APIs for everything you can imagine, except MMA. That's the reason we created Octagon API.

Now, MMA fan developers can create their own projects with their favorite fighters information, bringing a breath of fresh air to the common API based projects.

Also, we created a web page for displaying our database information.

🗃 API endpoints

https://api.octagon-api.com/
Endpoint Response
GET /rankings Returns whole rankings info.
GET /fighters Returns all fighters info.
GET /fighter/:fighterId Returns single fighter info.
GET /division/:divisionId Returns single division info.

For more extensive documentation, go to the API documentation

🤖 Scripts

Script Params Function
api:dev Starts a local instance of the API service.
api:publish Publishes the API. Requires wrangler installed and logged.
scrape Updates the /db the complete scraper: rankings and then fighter by fighter.
scrape:fighter --{fighterId} Updates /db/fighters.json with the provided fighter. Example: pnpm scrape:fighter --jon-jones.
scrape:fighters Updates complete /db/fighter.json.
scrape:rankings Updates /db/rankings.json.
lighthouse Generates and insert Lighthouse report badges in the README.md.

Project technical information

👩‍💻 Technologies

  • Front End: Astro, Svelte
  • PostCSS: autoprefixer
  • Scraper: NodeJS and node-html-parser
  • API: hono
  • Image processing: sharp

🦾 Providers

  • Web hosting: Vercel
  • API endpoints: Cloudfare workers

🎨 UI and web design

  • This is the used color palette.

  • These are the breakpoints used in the responsive design:

    • Tablet: 768px (48rem)
    • Desktop: 1024px (64rem)

octagon-api's People

Contributors

victor-lillo avatar dependabot[bot] avatar github-actions[bot] 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.