Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 2.87 KB

README.md

File metadata and controls

76 lines (48 loc) · 2.87 KB
Raw

superSimpleAgent

Authors: Seamus Brown, Clement Buchanan, Sang Lee, Jason Quaglia

Version: Collection 1.5.5

Overview

This is our code 301 Final Project while at Code Fellows. This is an app that helps you parse through the data received from an API call. Instead of trying to console.log() to parse through data in your own project, put the API link into our app to see the JSON object and get the relevant data (Remember, no API keys!). Our app will even give you the direct JavaScript that you need to access the data in your own project.

Problem Domain

As a user I want to see the info returned from API queries in a visually pleasant format so I don't have to spend hours parsing through unformatted console logs. I'd also like to see what other API's are out there that I might be able to use on my projects.

Getting Started (local server)

  1. Install packages: run npm init; then run npm install to get express, cors, pg, dotenv, superagent, fecha, pretty-print-json
  2. Once in IDE: add .env file, include: PORT and DATABASE_URL info
  3. Connect to database using psql: database name is associated with the DATABASE_URL info and the table name can be found in the schema.sql file
  4. Start nodemon

Architecture

This is a mobile first app. The client is build using EJS and is styled using CSS. The backend is built using node.js. It uses Postgres SQL for its database and heroku as the cloud platform for deployment. The code is hosted on GitHub on the team's superSimpleAgent repository.

Change Log

Timestamp - Description of activity 1612219947 - Initial set-up of database (table, schema, seed) and server

1612232048 - Confirmed Server working with Heroku deployment.

000000000 - Category search recommendations functional

000000000 - API search functionality works

1612393371812 - Pretify JSON and <pre> tag implemented to display JSON in user friendly manner

1612393371812 - About Me mobile and desktop view styled and contented

1612416220 - Overall site layout (e.g. base.css and layout.css) are complete. Recommendation feature is complete. Dynamic search and search error handling features are complete. JSON prettification is near-complete.

1612461409989 - mobile styling entirely complete

Dependencies

  • beautify:
  • cors:
  • dotenv:
  • ejs:
  • express:
  • fecha:
  • pg:
  • pretty-print-json:
  • superagent:

Database Schema

`DROP TABLE IF EXISTS apis;

CREATE TABLE apis ( id SERIAL PRIMARY KEY, url VARCHAR(255), time_stamp TIMESTAMP, code_name VARCHAR(255) );`

Credits and Collaborations

Nich Carignan Skyler Burger

Web Resources:

  • Search error handling page gif: https://tenor.com/view/milk-mocha-milk-and-mocha-bears-bored-wait-gif-13418519