Welcome to Free Code Camp's open source codebase!
Free Code Camp is an open-source community of busy people who learn to code and build projects for nonprofits.
Our campers (students) start by working through our free, self-paced, browser-based curriculum. Next, they build several practice projects. Finally, we pair two campers together with a stakeholder from a nonprofit organization, and help them build the solution the nonprofit has requested.
We help our campers build job-worthy portfolios of real apps used by real people, while helping nonprofits.
80% of our campers are over 25, and nearly a fifth of our campers are women.
Note: We're currently very close to moving from Express to Loopback. As such, please keep in mind that the instructions here for setting up and running the project do not directly translate to the staging branch. Additionally, the file structure is quite a bit different. As always, the staging branch is the appropriate place to branch off of to fix/add something.
We would love your help expanding our wiki. Our goal is to become a great resource for people learning to code, building local coding communities, and applying for coding jobs.
- Check our public Waffle Board.
- 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.
- Fork the project (Need help with forking a project?). You'll do all of your work on your forked copy.
- Create a branch specific to the issue or feature you are working on. Push your work to that branch. (Need help with branching?)
- Name the branch something like
xxxis a short description of the changes or feature you are attempting to add. For example
fix/email-loginwould be a branch where I fix something specific to email login.
- Once your code is ready, submit a pull request from your branch to Free Code Camp's
stagingbranch. 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.
The easiest way to get started is to clone the repository:
# 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
.env file with the following API keys accordingly. If you only use email login, only the
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
# 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 first-time # 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.
Copyright (c) 2015, Free Code Camp All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Free Code Camp nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY FREE CODE CAMP AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.