2014-12-24 18:57:40 +00:00
< img src = "https://s3.amazonaws.com/freecodecamp/logo4.0LG.png" >
2014-01-27 00:55:57 +00:00
2014-12-22 22:06:24 +00:00
Free Code Camp!
=======================
2013-12-29 23:43:07 +00:00
2014-12-24 18:57:40 +00:00
We're a community of busy people learning to code by collaborating on projects for nonprofits. We learn, then use, the JavaScript MEAN stack - MongoDB, Express.js, Angular.js and Node.js.
This app is live at [FreeCodeCamp.com ](http://www.FreeCodeCamp.com ), and we have a [chat room ](https://gitter.im/FreeCodeCamp/FreeCodeCamp ), [blog ](http://blog.freecodecamp.com ) and [forum ](http://forum.freecodecamp.com ), too. Join us!
2013-12-29 23:22:44 +00:00
Prerequisites
-------------
2014-04-14 22:57:57 +00:00
2014-02-02 09:20:53 +00:00
- [MongoDB ](http://www.mongodb.org/downloads )
- [Node.js ](http://nodejs.org )
2013-12-29 23:22:44 +00:00
2014-01-27 01:08:22 +00:00
Getting Started
---------------
2014-01-27 00:55:57 +00:00
2014-01-27 01:08:22 +00:00
The easiest way to get started is to clone the repository:
2014-01-12 04:22:26 +00:00
2014-01-27 01:08:22 +00:00
```bash
2014-06-03 04:43:47 +00:00
# Get the latest snapshot
2014-12-24 18:57:40 +00:00
git clone --depth=1 https://github.com/freecodecamp/freecodecamp.git freecodecamp
2014-01-27 01:08:22 +00:00
2014-12-24 18:57:40 +00:00
cd freecodecamp
2014-01-27 01:08:22 +00:00
# Install NPM dependencies
2013-12-29 23:22:44 +00:00
npm install
2014-01-27 01:08:22 +00:00
2014-12-24 18:57:40 +00:00
# Create a .env file and populate it with the necessary API keys and secrets:
touch .env
2014-02-01 05:45:15 +00:00
2014-12-24 18:57:40 +00:00
```
2014-02-05 16:37:48 +00:00
2014-12-24 18:57:40 +00:00
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:
2014-02-05 16:37:48 +00:00
2014-12-24 18:57:40 +00:00
```
2014-02-10 21:32:38 +00:00
2014-12-24 18:57:40 +00:00
MONGOHQ_URL='mongodb://localhost:27017/freecodecamp'
SESSION_SECRET='ANY ENGLISH PHRASE'
MANDRILL_USER='THE EMAIL ADDRESS FROM YOUR MANDRILL ACCOUNT'
MANDRILL_PASSWORD='YOUR MANDRILL PASSWORD'
FACEBOOK_ID='FACEBOOK APP API KEY'
FACEBOOK_SECRET='FACEBOOK SECRET'
GITHUB_ID='GITHUB APP API KEY'
GITHUB_SECRET='GITHUB APP SECRET'
TWITTER_KEY='TWITTER APP API KEY'
TWITTER_SECRET='TWITTER APP SECRET'
GOOGLE_ID='GOOGLE APP API KEY'
GOOGLE_SECRET='GOOGLE APP SECRET'
LINKEDIN_ID='LINKEDIN APP API KEY'
LINKEDIN_SECRET='LINKEDIN APP SECRET'
2014-04-22 05:18:31 +00:00
2014-12-24 18:57:40 +00:00
```
2014-04-22 05:18:31 +00:00
2014-12-24 18:57:40 +00:00
```bash
2014-02-10 21:32:38 +00:00
2014-12-24 18:57:40 +00:00
# Seed your database with the challenges
node seed_data/seed_challenges.js
2014-04-23 16:53:18 +00:00
2014-12-24 18:57:40 +00:00
# start the application
gulp
2014-04-23 16:53:18 +00:00
2014-12-24 18:57:40 +00:00
```
2014-04-23 16:53:18 +00:00
2014-01-27 07:03:30 +00:00
Project Structure
-----------------
2014-04-15 01:04:48 +00:00
| Name | Description |
| ---------------------------------- |:-----------------------------------------------------------:|
| **config** /passport.js | Passport Local and OAuth strategies, plus login middleware. |
| **config** /secrets.js | Your API keys, tokens, passwords and database URL. |
| **controllers** /contact.js | Controller for contact form. |
| **controllers** /home.js | Controller for home page (index). |
| **controllers** /user.js | Controller for user account management. |
2014-12-24 18:57:40 +00:00
| **controllers** /challenges.js | Controller for rendering the challenges. |
2014-04-15 01:04:48 +00:00
| **models** /User.js | Mongoose schema and model for User. |
2014-12-24 18:57:40 +00:00
| **models** /Challenge.js | Mongoose schema and model for Challenge. |
2014-04-15 01:04:48 +00:00
| **public** / | Static assets (fonts, css, js, img). |
| **public** /**js**/application.js | Specify client-side JavaScript dependencies. |
| **public** /**js**/main.js | Place your client-side JavaScript here. |
2014-12-24 18:57:40 +00:00
| **public** /**css**/main.less | Main stylesheet for the app. |
2014-04-15 01:04:48 +00:00
| **views/account** / | Templates for *login, password reset, signup, profile* . |
2014-02-06 12:21:47 +00:00
| **views/partials** /flash.jade | Error, info and success flash notifications. |
2014-01-29 04:06:33 +00:00
| **views/partials** /navigation.jade | Navbar partial template. |
| **views/partials** /footer.jade | Footer partial template. |
| **views** /layout.jade | Base template. |
| **views** /home.jade | Home page template. |
2014-01-31 12:20:13 +00:00
| app.js | Main application file. |
2014-04-15 01:04:48 +00:00
2014-01-27 12:05:56 +00:00
2014-02-14 18:09:43 +00:00
List of Packages
----------------
2014-04-15 01:56:47 +00:00
2014-12-24 18:57:40 +00:00
| Package | Description |
| ------------------------------- |:--------------------------------------------------------------------:|
| async | Utility library that provides asynchronous control flow. |
| bcrypt-nodejs | Library for hashing and salting user passwords. |
| cheerio | Scrape web pages using jQuery-style syntax. |
| clockwork | Clockwork SMS API library. |
| connect-assets | Compiles LESS stylesheets, concatenates & minifies JavaScript. |
| connect-mongo | MongoDB session store for Express. |
| csso | Dependency for connect-assets library to minify CSS. |
| express | Node.js web framework. |
| body-parser | Express 4.0 middleware. |
| cookie-parser | Express 4.0 middleware. |
| express-session | Express 4.0 middleware. |
| morgan | Express 4.0 middleware. |
| compression | Express 4.0 middleware. |
| errorhandler | Express 4.0 middleware. |
| method-override | Express 4.0 middleware. |
| express-flash | Provides flash messages for Express. |
| express-validator | Easy form validation for Express. |
| fbgraph | Facebook Graph API library. |
| github-api | GitHub API library. |
| jade | Template engine for Express. |
| less | LESS compiler. Used implicitly by connect-assets. |
| helmet | Restricts Cross site requests. You can modify its settings in app.js |
| mongoose | MongoDB ODM. |
| nodemailer | Node.js library for sending emails. |
| passport | Simple and elegant authentication library for node.js |
| passport-facebook | Sign-in with Facebook plugin. |
| passport-github | Sign-in with GitHub plugin. |
| passport-google-oauth | Sign-in with Google plugin. |
| passport-twitter | Sign-in with Twitter plugin. |
| passport-local | Sign-in with Username and Password plugin. |
| passport-linkedin-oauth2 | Sign-in with LinkedIn plugin. |
| passport-oauth | Allows you to set up your own OAuth 1.0a and OAuth 2.0 strategies. |
| request | Simplified HTTP request library. |
| lodash | Handy JavaScript utlities library. |
| uglify-js | Dependency for connect-assets library to minify JS. |
| mocha | Test framework. |
| chai | BDD/TDD assertion library. |
| supertest | HTTP assertion library. |
| multiline | Multi-line strings for the generator. |
2014-01-29 04:03:16 +00:00
2014-06-17 02:55:48 +00:00
2014-04-15 03:14:56 +00:00
Changelog
2014-04-14 03:06:42 +00:00
---------
2014-04-26 19:03:44 +00:00
2014-12-24 18:57:40 +00:00
### 0.1.0 (December 24, 2014)
- Improved how unique emails and usernames are handled (with Express-validator)
- Added a tweet button to challenge completion model
- Refactored all views to get rid of any hard-coded challenge information (to make for a better forking experience)
- Installed Helmet to maximize security of application
- Added .env and removed all trace of API keys from git history
2014-04-14 03:06:42 +00:00
2013-12-30 00:08:27 +00:00
Contributing
------------
2014-04-15 03:14:56 +00:00
2014-12-24 18:57:40 +00:00
We welcome pull requests from Free Code Camp "Code Campers" (our students) and seasoned JavaScript developers alike!
1) Check our [public Trello Board ](https://trello.com/b/CW5AFr0v/free-code-camp-development )
2) If your issue or feature isn't on the board, either open an issue on this GitHub repo or message Quincy Larson to request to be added to the Trello board.
3) Once your code is ready, submit the pull request. We'll do a quick code review and give you feedback, and iterate from there.
This project uses [Airbnb JavaScript Style Guide ](https://github.com/airbnb/javascript ) with a
2014-04-15 03:14:56 +00:00
few minor exceptions. If you are submitting a pull request that involves
Jade templates, please make sure you are using *spaces* , not tabs.
2014-01-27 02:25:56 +00:00
License
-------
2014-04-15 03:14:56 +00:00
2014-01-27 02:25:56 +00:00
The MIT License (MIT)
2014-12-24 18:57:40 +00:00
Copyright (c) 2015 Sahat Yalkabov (creator of the Hackathon Starter App with which Free Code Camp started)
Copyright (c) 2015 Quincy Larson (the guy who started Free Code Camp and wrote a lot of the code here)
2014-01-27 02:25:56 +00:00
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
2014-01-27 03:39:22 +00:00
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
