r
/
p5.js-web-editor
1
0
Fork 0
Code Issues 1 Pull Requests Releases 1 Wiki Activity

Merge branch 'abhinavsagar-abhinavdoc1'

This commit is contained in:
Cassie Tarakajian 2019-03-28 16:34:36 -04:00
parent 391a92a1fd 15b38a0bc8
commit f8499f3375
3 changed files with 29 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
developer_docs/deployment.md
View File

@ -29,6 +29,8 @@ These are the steps that happen when you deploy the application.
You'll only need to do this if you're testing the production environment locally.
_Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
1. Clone this repository and `cd` into it
2. `$ npm install`
3. Install MongoDB and make sure it is running

10
developer_docs/installation.md
View File

@ -4,16 +4,18 @@ Follow these instructions to set up your development environment, which you need
## Manual Installation
_Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
1. Install [node.js](http://nodejs.org/), which also automatically installs the [npm](https://www.npmjs.org) package manager.
2. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account.
3. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer.
3. [Clone](https://help.github.com/articles/cloning-a-repository/) your new fork of the repository from GitHub onto your local computer.
```
$ git clone https://github.com/YOUR_USERNAME/p5.js-web-editor.git
```
4. Navigate into the project folder and install all its necessary dependencies with npm.
```
$ cd p5.js-web-editor
$ npm install
@ -31,6 +33,8 @@ Follow these instructions to set up your development environment, which you need
## Docker Installation
_Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
Using Docker, you can have a complete, consistent development environment without having to manually install dependencies such as Node, Mongo, etc. It also helps isolate these dependencies and their data from other projects that you may have on the same computer that use different/conflicting versions, etc.
Note that this takes up a significant amount of space on your machine. Make sure you have at least 5GB free.
@ -75,4 +79,4 @@ name, you can also set it using this variable. I.e.:
For more information on using a custom domain, see this documentation link:
http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingCustomURLs
http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingCustomURLs

38
developer_docs/preparing_a_pull_request.md
View File

@ -1,15 +1,15 @@
# Preparing a pull request
Copied from the [p5.js repository](https://github.com/processing/p5.js).
Copied and updated from the [p5.js repository](https://github.com/processing/p5.js).
Pull-requests are easier when your code is up to date! You can use git rebase to update your code to incorporate changes from other contributors. Here's how.
## Save and Update
### Save everything you have!
git status
### Save everything you have!
git status
git add -u
git commit
git commit
### Find out about changes
@ -23,25 +23,27 @@ If you see an error, you'll need to start tracking the main p5.js repo as an "up
Then ask git about the latest changes.
git fetch upstream
git fetch upstream
### Just in case: make a copy of your changes in a new branch
git branch your-branch-name-backup
git branch your-branch-name-backup
### Apply changes from master branch, adds your changes *after*
git rebase upstream/master
### Apply changes from master branch, adds your changes *after*
git rebase upstream/master
### Switches back to master branch
git checkout master
### Helps other contributors fully understand the changes that you made
git commit -m "Fixed documentation typos"
### Verifies what git will be committing
git status
## CONFLICTS
You will probably have some conflicts!
If it’s just lib/p5.js and lib/p5.min.js, it’s easy to fix. just build the project again with grunt.
grunt
git add -u
git rebase --continue
If you have conflicts in other files & you're not sure how to resolve them... ask for help! Lauren, David, Kevin, and Kate are familiar with recent changes and can help you figure out what's new.
You may have some conflicts! It's okay. Feel free to ask for help. If merging with the latest upstream master causes conflicts, you can always make a pull request with the upstream repository, which makes the merge conflicts public.
## And finally, for great glory
git push origin
git push --set-upstream origin your-branch-name-backup
Here's a good reference on rebasing, in case you're intensely curious about the technical details. https://www.atlassian.com/git/tutorials/merging-vs-rebasing
Here's a good reference on rebasing, in case you're intensely curious about the technical details. https://www.atlassian.com/git/tutorials/merging-vs-rebasing