Code Monkey home page Code Monkey logo

adorableclowder's Introduction

Skillit Build Status

Skillit is a skill-sharing platform that facilitates matchmaking between passionate learners and teachers. Come out of your shell and share your yolk with the world!

Team

  • Product Owner: Michael Arnold
  • Scrum Master: Justin Thareja
  • Development Team Members: Sarah Yu, Austin Worachet

Table of Contents

  1. Requirements
  2. Development
    1. Getting Started
    2. Client/Server Architecture
    3. Database Architecture
  3. Roadmap
  4. Contributing

Requirements

  • Node 0.10.x
  • MYSQL 5.x
  • npm 2.10.x
  • bower 1.4.x

Development

Getting Started

Step 1: Fork the repo to your own github profile

Step 2: Clone your fork to a local directory on your computer

$ git clone https://github.com/YOUR_USERNAME/AdorableClowder.git

Step 3: Open a new terminal window and navigate to your clone of AdorableClowder

Step 4: Install Dependencies

$ npm install

Step 5: Open a new terminal window to start mySQL and log in

$ mysql.server start
$ mysql -u root

Step 6: Create a local database called 'clowderdb' from within mySQL

mysql> CREATE DATABASE clowderdb;

Step 7: Start the server with grunt

$ grunt

Step 8: Navigate to localhost:1337 in your browser and start hacking!

Client/Server Architecture

alt tag

Database Architecture

alt tag

  • offers contains all skills that users are willing to teach others.
  • wants contains all skills that users want to learn from others.
  • users_offers is a join table that contains each unique relationship between a user and a skill they have to offer
  • users_wants is a join table that cointains each unique relationship between a user and a skill they wish to learn

To query the DB manually, make sure mySQL is set to use the clowderdb database created previously. Once logged into mySQL:

mysql> \u clowderdb

Roadmap

View the project roadmap here

Contributing

see docs/CONTRIBUTING.md for contribution guidelines.

adorableclowder's People

Contributors

adlaika avatar austinwo avatar dgdblank avatar hackreactor-students avatar jseiden avatar justinthareja avatar kidmillions avatar syu15 avatar vliang63 avatar

Watchers

 avatar  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.