Giter Site home page Giter Site logo

classroom-mode's Introduction

FCC Classroom Mode

freeCodeCamp

Build Status

Architecture

The application currently has a react frontend and an express backend. The frontend is located inside of the the '/client' folder, while the backend is located inside of the '/server' folder. Both the client and the server run as seperate web applications, which means that they each have a separate server. The react server is runs on port 8080, while the express server runs on port 8083.

The react server proxies requests to the express server (see /client/package.json to see how the proxy is defined).

Install

npm run setup to install both server and client applications dependencies.

If running on cloud9, you must rename the .env.development.cloud9 as .env.development. Note that you should not commit this file to github. It should be disabled when deploying to a productoin environment

To run the application, you must start both the client and the server:

npm run dev to start both servers

Or you may run the below script in separate terminals

npm run server
npm run client

Setup Database Configuration

cp server/variables.env.sample server/variables.env

Run Test

npm test

Contributors

We welcome pull requests from freeCodeCamp campers (our students) and seasoned JavaScript developers alike! See the list of contributors who participated in writing this tool.

To get started the first thing you're going to want to do is fork this repository over to your personal github.

Next, go ahead and clone the repo from your repository locally. From there you have two steps:

git remote add upstream https://github.com/freeCodeCamp/classroom-mode.git

Then go ahead fetch the changes.

git fetch upstream

Afterward, you will want to create a new branch locally with git checkout -b BRANCHNAME

When you're done and ready for a pull request fetch and merge anything that's been done on the upstream/master into your newly created BRANCHNAME and resolve any merge conflicts.

License

Copyright (c) 2018 freeCodeCamp.

The computer software in this repository is licensed under the BSD-3-Clause.

classroom-mode's People

Contributors

angelgonzalezleon avatar cullenmar avatar honoriovega avatar imcodingideas avatar jasonkirn avatar ojongerius avatar rivera1294 avatar user512 avatar utsab avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.