https://github.com/bschwind/api-starter-kit
Something easy I can fork when writing new APIs
https://github.com/bschwind/api-starter-kit
Last synced: about 1 year ago
JSON representation
Something easy I can fork when writing new APIs
- Host: GitHub
- URL: https://github.com/bschwind/api-starter-kit
- Owner: bschwind
- Created: 2015-07-13T05:15:33.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-06-10T13:30:34.000Z (about 4 years ago)
- Last Synced: 2025-04-06T23:44:45.069Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.67 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
api-starter-kit
===============
This project is half an educational tool for me to learn more infrastructure
and half an easy starting point for making HTTP APIs
Dependencies
------------
- VirtualBox
- Vagrant
- Docker
Build
-----
$ vagrant up
Run
---
$ vagrant ssh
$ cd starter-kit
$ node app.js
Visit `http://localhost:8080/api/v1/ping` in your browser. If everything is running, you should get PONG as a response.
I currently don't have any fancy auto-running tools for Node, as this is for
development, and most tools that reload on code changes seem to perform slowly
on VirtualBox VMs.
Debug
-----
# Run the PostgreSQL shell:
$ psql -d DB_NAME -h DB_HOSTNAME -U DB_USERNAME