/react-capstone

API Hub: Online Repository for Public API Endpoints

Primary LanguageCSS



API Hub

A (not so) Massive Online Repository for API Endpoints

Travis

Key FeaturesPreviewHow To UseAPIThe StackA Special Thank YouRelatedLicense

screenshot

Key Features

  • Free!
  • Search for public APIs
  • Quickly and easily navigate query parameters
  • GUI for adding endpoints for various Public APIs

Preview

Landing Page

screenshot

Browse

screenshot

Endpoint

screenshot

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

The application can be run in two different ways:

  1. Back-end API only
  2. Full application
  3. Full application with proxy to back-end

Back-end API only

# Clone this repository
$ git clone https://github.com/johnatspreadstreet/react-capstone.git

# Go into the repository
$ cd react-capstone

# Install dependencies
$ npm install

# Run the backend api
$ npm start

Full application

# Clone this repository
$ git clone https://github.com/johnatspreadstreet/react-capstone.git

# Go into the repository
$ cd react-capstone

# Install dependencies
$ npm install
$ cd client/
$ npm install

# Run the backend api
$ npm start

# Run the front end React app
$ cd client/
$ npm start

Full application with proxy to back-end

# Clone this repository
$ git clone https://github.com/johnatspreadstreet/react-capstone.git

# Go into the repository
$ cd react-capstone

# Install dependencies
$ npm install
$ cd client/
$ npm install

# Make sure you are back in root directory, and run proxy build
$ cd ..
$ npm run proxy

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

API

API Documentation can be found at the following link: https://warm-peak-72707.herokuapp.com/api/docs

The Stack

Front-end

  • React
  • React-Router
  • Redux
  • Redux Thunk
  • Redux Forms
  • Axios
  • Highlightjs
  • Enzyme
  • Jest
  • Tailwindcss

Back-end

  • Express
  • MongoDB
  • Mongoose
  • Mocha
  • Chai

Authentication

  • JWT
  • Passportjs
  • Bcryptjs

A Special Thank You

A very big thank you goes out to the following individuals who helped me create API Hub. It would not have been possible without you:

Related

To use the website as an Office Add-in, you must do the following:

  1. Generate (or use a default) manifest.xml
  2. Include the Office JS CDN script in public/index.html
  3. Include an Office.onReady() function in the app's entry point
  4. npm i office-addin-validator office-toolbox
  5. Include additional polyfills for IE11
  6. Add script to package json 'set HTTPS=true&&npm run start'
  7. Self-signed certificates for localhost (these are located in Thinkful -> local-cert-generator)

License

Honestly, do whatever you want with it. Just give attribution.