https://github.com/chrisdwheatley/endpointer
Rapidly serve static JSON endpoints to your front end application
https://github.com/chrisdwheatley/endpointer
Last synced: about 1 month ago
JSON representation
Rapidly serve static JSON endpoints to your front end application
- Host: GitHub
- URL: https://github.com/chrisdwheatley/endpointer
- Owner: chrisdwheatley
- Created: 2013-11-14T22:51:48.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-12-03T21:32:56.000Z (over 11 years ago)
- Last Synced: 2025-01-28T19:16:18.575Z (3 months ago)
- Language: CSS
- Homepage:
- Size: 309 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Endpointer
Endpointer allows rapid integration of JSON endpoints into your front end application, helping you;
* Have a set of reliable endpoints to hit when your application may be in a state of flux
* Keep stubbed or test JSON out of your codebase
* Easily amend the values being passed through into your application
## Getting Started
Endpointer is being developed with the aim of being a deployable instance accessible to your whole team. Currently however the quickest and most reliable way to get up and running is to use the application on your local machine.
#### Dependencies
* nodejs
* npm
#### Local Machine
Clone the repository
```
$ git clone [email protected]:swirlycheetah/endpointer.git
```
Switch to the Endpointer folder
```
$ cd endpointer
```
Install the required dependencies
```
$ npm install
```
Start the application
*By default Endpointer runs on port 80, you can amend this by passing though a port argument followed by the desired port number.*
```
$ node src/endpointer.js
```
or
```
$ node src/endpointer.js port
```
Open the application within your browser by visiting `localhost` or `localhost:` respectively to begin uploading endpoints.
## Roadmap
This is very much an alpha release, there are many more features planned, including;
* Tests
* Full Heroku support (currently you can deploy to Heroku but there is no support for true file uploads as Heroku has an ephemeral filesystem)
* EC2 support
* Design
## Licence
Endpointer is released under the MIT license:
[opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)