Giter Club home page Giter Club logo

bsit-challenge's Introduction

League of Legends Champion React Web-App

Stack

  • ES6 Javascript standard
  • Node.js w/ Express.js framework
  • MongoDB w/ Monk.js driver
  • React.js

Setup

Local

I suggest creating a .env file with the following in the root directory if you wish to run another environment or specify your own DB URL:

ENVIRONMENT="development"
MONG0DB_URL="..."

and another in the root of the React app:

SKIP_PREFLIGHT_CHECK=true

Make sure that MongoDB is running on a localhost port if you wish to connect to a DB to run seed jobs.

To run the backend API, run the following:

$ npm i
$ npm run start
$ info: api.seeds.seedChampions: champion list has already been seeded
$ info: api.bin.www#onListening: listening on port 3001

To run the React web-app:

$ cd ui && npm i
$ npm run start

A development window will open in your browser.

Production

A compiled production web-app is available at https://bsit-champions.herokuapp.com.

API Endpoints

  • GET /api/champions/
    • Takes option parameters limit and offset as query parameters. limit defaults to 10, offset defaults to 0. Sending a value < 1 for limit returns all results.
    • Returns a JSON array of champions ordered A-Z
  • GET /api/champions/:championId
    • Returns a JSON object for the relevant championId

bsit-challenge's People

Contributors

oflynned 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.