update readme

This commit is contained in:
DavidWells 2018-06-28 17:55:20 -07:00
parent 0a90e120ca
commit 0d1d66c780

View file

@ -11,40 +11,40 @@ Deploy this app with one-click via this link:
This application is using [React](https://reactjs.org/) for the frontend, [Netlify Functions](https://www.netlify.com/docs/functions/) for API calls, and [FaunaDB](https://fauna.com/) as the backing database. This application is using [React](https://reactjs.org/) for the frontend, [Netlify Functions](https://www.netlify.com/docs/functions/) for API calls, and [FaunaDB](https://fauna.com/) as the backing database.
![faunadb netlify](https://user-images.githubusercontent.com/532272/42067494-5c4c2b94-7afb-11e8-91b4-0bef66d85584.png) ![faunadb netlify](https://user-images.githubusercontent.com/532272/42067494-5c4c2b94-7afb-11e8-91b4-0bef66d85584.png)
## Install ## Install
1. Clone down the repository 1. Clone down the repository
```bash ```bash
git clone git@github.com:netlify/netlify-faunadb-example.git git clone git@github.com:netlify/netlify-faunadb-example.git
``` ```
2. Install the dependencies 2. Install the dependencies
```bash ```bash
npm install npm install
``` ```
3. Bootstrap your FaunaDB table 3. Bootstrap your FaunaDB table
```bash ```bash
npm run bootstrap npm run bootstrap
``` ```
4. Set your Fauna API key value in your terminal enviroment 4. Set your Fauna API key value in your terminal enviroment
You can create faunaDB keys here: https://dashboard.fauna.com/db/keys You can create faunaDB keys here: https://dashboard.fauna.com/db/keys
In your terminal run the following command: In your terminal run the following command:
```bash ```bash
export FAUNADB_SECRET=YourFaunaDBKeyHere export FAUNADB_SECRET=YourFaunaDBKeyHere
``` ```
5. Run project locally 5. Run project locally
```bash ```bash
npm start npm start
``` ```