From b3150b553b4986f3f236f97fc05222eaaf2fe199 Mon Sep 17 00:00:00 2001 From: Jake Meyer Date: Wed, 8 Aug 2018 04:04:17 -0500 Subject: [PATCH] readme updates --- README.md | 14 +++++++------- docs/development.md | 2 -- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7f8021e2..68f5069f 100644 --- a/README.md +++ b/README.md @@ -121,16 +121,16 @@ curl -s https://api.spacexdata.com/v2/launches/latest | jq See the [Contribution](https://github.com/r-spacex/SpaceX-API/blob/master/CONTRIBUTING.md) guide for detailed steps ## Local Development -Local development info can be found [here](https://github.com/r-spacex/SpaceX-API/wiki/Local-Development) +Local development info can be found [here](https://github.com/r-spacex/SpaceX-API/blob/master/docs/development.md) ## Technical Details -* API is using [Node.js](https://nodejs.org/en/) with the [Koa](http://koajs.com/) framework +* Deployed on a central U.S. [Linode](https://www.linode.com/) server +* Using [Node.js](https://nodejs.org/en/) with the [Koa](http://koajs.com/) framework +* Using [Redis](https://redis.io/), [Nginx](https://www.nginx.com/), and [Cloudflare](https://www.cloudflare.com/) for content caching +* Using [Jest](https://facebook.github.io/jest/) and [Supertest](https://github.com/visionmedia/supertest) for tests +* Using [Travis CI](https://travis-ci.org/) for continuous integration / deployments * All data stored in a [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) 3 node replica set cluster -* Latest database mongodump available [here](https://drive.google.com/drive/folders/0B2DdgKR4GR4xdk1sRGowcUZXeE0?usp=sharing) -* Uses [Redis](https://redis.io/) on [RedisCloud](https://redislabs.com/redis-enterprise/cloud/) for route caching -* Uses [Jest](https://facebook.github.io/jest/) and [Supertest](https://github.com/visionmedia/supertest) for tests -* Uses [Travis CI](https://travis-ci.org/) for continuous integration/delivery -* API deployed on a [Heroku](https://www.heroku.com/) pipeline with pull request, staging and production servers +* Latest database mongodump and zipped JSON files available [here](https://drive.google.com/drive/folders/0B2DdgKR4GR4xdk1sRGowcUZXeE0?usp=sharing) ## FAQ's * If you have any questions or corrections, please open an issue and we'll get it merged ASAP diff --git a/docs/development.md b/docs/development.md index 3e71aab7..3451081e 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,7 +1,5 @@ ### Without Docker -[Home](https://github.com/r-spacex/SpaceX-API/blob/master/docs/home.md) | [Launches](https://github.com/r-spacex/SpaceX-API/blob/master/docs/launches.md) | [Rockets](https://github.com/r-spacex/SpaceX-API/blob/master/docs/rocket.md) | [Capsules](https://github.com/r-spacex/SpaceX-API/blob/master/docs/capsule.md) | [Company Info](https://github.com/r-spacex/SpaceX-API/blob/master/docs/company_info.md) | [Roadster Info](https://github.com/r-spacex/SpaceX-API/blob/master/docs/roadster.md) | [Capsule Details](https://github.com/r-spacex/SpaceX-API/blob/master/docs/capsule_detail.md) | [Core Detail](https://github.com/r-spacex/SpaceX-API/blob/master/docs/core_detail.md) | [Launchpads](https://github.com/r-spacex/SpaceX-API/blob/master/docs/launchpad.md) - 1. Clone the repo ```bash git clone https://github.com/r-spacex/SpaceX-API.git && cd SpaceX-API