formatting readme

This commit is contained in:
Lauren McCarthy 2016-08-01 18:26:53 +10:00
parent c95d3ac671
commit 7473403564

View file

@ -8,16 +8,15 @@ This project is currently in the early stages of development! It will definitely
2. `$ npm install` 2. `$ npm install`
3. Install MongoDB and make sure it is running 3. Install MongoDB and make sure it is running
4. Create a file called `.env` in the root of this directory that looks like 4. Create a file called `.env` in the root of this directory that looks like
```bash ```bash
MONGO_URL=mongodb://localhost:27017/p5js-web-editor MONGO_URL=mongodb://localhost:27017/p5js-web-editor
PORT=8000 PORT=8000
SESSION_SECRET=whatever_you_want_this_to_be_it_only_matters_for_production SESSION_SECRET=whatever_you_want_this_to_be_it_only_matters_for_production
AWS_ACCESS_KEY=<your-aws-access-key> AWS_ACCESS_KEY=<your-aws-access-key>
AWS_SECRET_KEY=<your-aws-secret-key> AWS_SECRET_KEY=<your-aws-secret-key>
S3_BUCKET=<your-s3-bucket> S3_BUCKET=<your-s3-bucket>
``` ```
Or, if you don't want to do that, just ask me to send you mine. Refer to [this gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) for creating an S3 bucket for testing, or if you don't want to do that, I will send you my AWS credentials. Or, if you don't want to do that, just ask me to send you mine. Refer to [this gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) for creating an S3 bucket for testing, or if you don't want to do that, I will send you my AWS credentials.
5. `$ npm start` 5. `$ npm start`
6. Navigate to (http://localhost:8000)[http://localhost:8000] in your browser 6. Navigate to (http://localhost:8000)[http://localhost:8000] in your browser
7. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en). 7. Install the [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en).
@ -28,16 +27,15 @@ Or, if you don't want to do that, just ask me to send you mine. Refer to [this g
2. `$ npm install` 2. `$ npm install`
3. Install MongoDB and make sure it is running 3. Install MongoDB and make sure it is running
4. Create a file called `.env` in the root of this directory that looks like 4. Create a file called `.env` in the root of this directory that looks like
```bash ```bash
MONGO_URL=mongodb://localhost:27017/p5js-web-editor MONGO_URL=mongodb://localhost:27017/p5js-web-editor
PORT=8000 PORT=8000
SESSION_SECRET=make_this_a_long-random_string_like_maybe_126_characters_long SESSION_SECRET=make_this_a_long-random_string_like_maybe_126_characters_long
AWS_ACCESS_KEY=<your-aws-access-key> AWS_ACCESS_KEY=<your-aws-access-key>
AWS_SECRET_KEY=<your-aws-secret-key> AWS_SECRET_KEY=<your-aws-secret-key>
S3_BUCKET=<your-s3-bucket> S3_BUCKET=<your-s3-bucket>
``` ```
Or, if you don't want to do that, just ask me to send you mine. Refer to [this gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) for creating an S3 bucket for testing, or if you don't want to do that, I will send you my AWS credentials. Or, if you don't want to do that, just ask me to send you mine. Refer to [this gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) for creating an S3 bucket for testing, or if you don't want to do that, I will send you my AWS credentials.
5. `$ npm run build` 5. `$ npm run build`
6. `$ npm run start:prod` 6. `$ npm run start:prod`