Consolidate contributors instructions into CONTRIBUTING.md
This commit is contained in:
Peter Benjamin
97
README.md
97
README.md
@@ -31,102 +31,7 @@ We would love your help expanding our [wiki](https://github.com/freecodecamp/fre
|
||||
Contributing
|
||||
------------
|
||||
|
||||
We welcome pull requests from Free Code Camp campers (our students) and seasoned JavaScript developers alike! Follow these steps to contribute:
|
||||
|
||||
1. Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp).
|
||||
2. Pick an issue that nobody has claimed and start working on it. If your issue isn't on the board, open an issue. If you think you can fix it yourself, start working on it. Feel free to ask for help in our [Gitter](https://gitter.im/FreeCodeCamp/FreeCodeCamp).
|
||||
3. Fork the project ([Need help with forking a project?](https://help.github.com/articles/fork-a-repo/)). You'll do all of your work on your forked copy.
|
||||
4. Create a branch specific to the issue or feature you are working on. Push your work to that branch. ([Need help with branching?](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches))
|
||||
5. Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example `fix/email-login` would be a branch where I fix something specific to email login.
|
||||
6. You should have [ESLint running in your editor](http://eslint.org/docs/user-guide/integrations.html), and it will highlight anything doesn't conform to [Free Code Camp's JavaScript Style Guide](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Free-Code-Camp-JavaScript-Style-Guide) (you can find a summary of those rules [here](https://github.com/FreeCodeCamp/FreeCodeCamp/blob/staging/.eslintrc). Please do not ignore any linting errors, as they are meant to **help** you and to ensure a clean and simple code base. Make sure none of your JavaScript is longer than 80 characters per line.
|
||||
7. Once your code is ready, submit a [pull request](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Pull-Request-Contribute) from your branch to Free Code Camp's `staging` branch. We'll do a quick code review and give you feedback, then iterate from there. It may also be helpful to read about git [rebasing](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/git-rebase).
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
- [MongoDB](http://www.mongodb.org/downloads)
|
||||
- [Node.js](http://nodejs.org)
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
The easiest way to get started is to clone the repository:
|
||||
|
||||
```bash
|
||||
# Get the latest snapshot
|
||||
git clone --depth=1 https://github.com/freecodecamp/freecodecamp.git freecodecamp
|
||||
|
||||
# Change directory
|
||||
cd freecodecamp
|
||||
|
||||
# Install NPM dependencies
|
||||
npm install
|
||||
|
||||
# Install Gulp globally
|
||||
npm install -g gulp
|
||||
|
||||
# Install Bower globally
|
||||
npm install -g bower
|
||||
|
||||
# Install Bower dependencies
|
||||
bower install
|
||||
|
||||
# Create a .env file and populate it with the necessary API keys and secrets:
|
||||
touch .env
|
||||
```
|
||||
|
||||
Edit your `.env` file with the following API keys accordingly. If you only use email login, only the `MONGOHQ_URL`, `SESSION_SECRET`, `MANDRILL_USER` and `MANDRILL_PASSWORD` fields are necessary. Keep in mind if you want to use more services you'll have to get your own API keys for those services. If you only use a subset or no OAuth2 authentication methods, you may want to remove them from ```server/passport-providers.js``` - otherwise the server will complain about missing clientIDs at launch.
|
||||
|
||||
```
|
||||
MONGOHQ_URL='mongodb://localhost:27017/freecodecamp'
|
||||
|
||||
FACEBOOK_ID=stuff
|
||||
FACEBOOK_SECRET=stuff
|
||||
|
||||
GITHUB_ID=stuff
|
||||
GITHUB_SECRET=stuff
|
||||
|
||||
GOOGLE_ID=stuff
|
||||
GOOGLE_SECRET=stuff
|
||||
|
||||
LINKEDIN_ID=stuff
|
||||
LINKEDIN_SECRET=stuff
|
||||
|
||||
MANDRILL_PASSWORD=stuff
|
||||
MANDRILL_USER=stuff
|
||||
|
||||
TRELLO_KEY=stuff
|
||||
TRELLO_SECRET=stuff
|
||||
|
||||
TWITTER_KEY=stuff
|
||||
TWITTER_SECRET=stuff
|
||||
TWITTER_TOKEN=stuff
|
||||
TWITTER_TOKEN_SECRET=stuff
|
||||
|
||||
BLOGGER_KEY=stuff
|
||||
|
||||
SESSION_SECRET=secretstuff
|
||||
COOKIE_SECRET='this is a secret'
|
||||
|
||||
PEER=stuff
|
||||
DEBUG=true
|
||||
```
|
||||
|
||||
```bash
|
||||
# Start the mongo server in a seperate terminal
|
||||
mongod
|
||||
|
||||
# Initialize Free Code Camp
|
||||
# This will seed the database for the first time.
|
||||
# This command should only be run once.
|
||||
npm run only-once
|
||||
|
||||
# start the application
|
||||
gulp
|
||||
```
|
||||
Now navigate to your browser and open http://localhost:3001
|
||||
If the app loads, congratulations - you're all set. Otherwise, let us know by opening a GitHub issue and with your error.
|
||||
|
||||
We welcome pull requests from Free Code Camp campers (our students) and seasoned JavaScript developers alike! Please, follow [these steps](CONTRIBUTING.md) to contribute.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Reference in New Issue
Block a user