Giter VIP home page Giter VIP logo

js-toolkit's Introduction

JS Toolkit: a training application for beginners to JavaScript

Deployed Site

Youtube Walkthrough

Instructions

To run locally

  • Fork and clone the respo
  • In command line, git clone {insert-your-repo-SSH-key}
  • Run npm install in the root and the client file
  • Run brew install yarn
  • In order to view on your local host, run the commmand 'npm run dev'
  • You will likelly need/want to create an Mlab Account and create a MongoDB deployment for development. You can then store the MONGO_URI in a dev.js file in /config/ file
  • You will also need to sign up for google's google+ oauth api and create a development Google Client Secret and Google Client Id in that dev.js file in /config/. You can search on googles developer console for 'Google+' and that should bring up the correct api
  • You will also need to set your own cookieKey in a dev.js file in /config/ file. That way index.js of the server will be able to use that variable.

Future Iterations

  1. The code block testing needs to be built out to dynamically test user code entries, accounting for spaces, syntax variations, etc. A secure console needs to be able to run user code entries as javascript, compare them to a database entry and return true or false depending on if the values returned match or not
  2. The MailChimp API will be integrated once a proper testing structure has been put in place and lessons can be built out
  3. The ranking system will be built out next, which will be very simple based on the switch statement in the code base, once a proper testing console is in place and the mailchimp api is integrated

To Contribute

  • Contribute lessons by issuing a pull request. Creat a new file in the client/src/lessons_content folder and set up the file with the following structure. See the existing file lesson_01_arr_length for how the following may be written

  • category: Array (or String, Math, Object)

  • method_name: e.g. Array.map

  • Title: (a fun title that encapsulates what the user will be learning about)

  • Technical Summary: e.g. Array.map() is used for xyz and is useful in xyz situations and contexts.

  • Content 1: (this needs to be in markdown!) This is the layman terms explanation for what the method does and how its used.

  • Youtube URL: the url of your youtube education lesson. (every lesson must have a youtube tutorial)

  • Code Challenge Description 1: (must be in markdown) a description of the first code challenge using that method

  • Solution for Code Challenge 1: (not in markdown)

  • Code Challenge Description 2: (must be in markdown) a description of the second code challenge using that method

  • Solution for Code Challenge 2: (not in markdown)

  • Content 2: this is a wrap up of the lesson

Please email [email protected] with any questions or help

js-toolkit's People

Contributors

colecarroll avatar

Stargazers

Charlie McClung avatar

Watchers

James Cloos avatar Charlie McClung 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.