JS Personal API

An API for my public data

JS Personal API is an opinionated Node.js and Express app that serves as an interface to my public data on various online networks and providers. The goal is to replace the static data I'm currently using for my website with calls to this API.

This project is new and unstable. Use at your discretion.

» Install

Use npm to install dependencies.

npm install

Create a new file at .env containing your Firebase database credentials.

FIREBASE_API_KEY=YOUR_API_KEY
FIREBASE_DATABASE_URL=https://YOUR_DATABASE_URL.firebaseio.com
FIREBASE_PROJECT_ID=YOUR_PROJECT_ID

» Integrations

The providers I intended to integrate are:

GitHub

• Repositories
• Profile

Flikr

• Recent photos

Instagram

• Recent photos

Twitter

• Tweets

» Endpoints

The endpoints available are:

route	response
GET /composite	returns all collections
GET /metas	get all meta data
GET /profiles	get all profiles
GET /projects	get all projects (param repository=expanded includes repository data)
GET /repositories	get all repositories

» Commands

The npm commands available are:

command	description
build	build project
report-coverage	run and report code coverage
start	starts the local web server
sync:repositories	get or sync repositories for all projects
test	runs the unit tests

License