Git Product home page Git Product logo

azcraze / empirical-core Goto Github PK

View Code? Open in Web Editor NEW

This project forked from quinn/empirical-grammar

0.0 1.0 0.0 38.67 MB

Empirical-Core is our web app for managing students, assigning activities, and viewing results. Core seamlessly incorporates 3rd party applications via the Empirical API.

Home Page: http://www.quill.org/

License: GNU Affero General Public License v3.0

JavaScript 35.61% Ruby 33.74% HTML 9.29% CSS 11.36% SQLPL 9.98% Shell 0.01%

empirical-core's Introduction

Documentation Table of Contents

Welcome to Empirical Core

Empirical Core is the Learning Management System that powers Quill.org, a free writing tool.

Front End Back End Travis CI
codecov codecov Build Status

Fork and Clone this repository to submit a Pull Request.

Getting Started: Visit our Community Page. The Mailing List, Chat, Issues, and Docs can all be accessed from the community page.

CLA: Please register an account & sign our CLA.

Install Empirical Core

Here's how to get Empirical Core running on your system:

  1. Download and install rbenv (or another Ruby version manager of your choice). You need to have Ruby version 2.3.1 installed in order to use Empirical Core. The best way to make sure you have version 2.3.1 is to follow the README and wiki of the Ruby version manager that you download.

    If you decide to use rbenv, then homebrew has a really great and easy-to-use setup and install process:

    1. brew update
    2. brew install rbenv ruby-build
    3. echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
    4. Close and reopen your terminal.
  2. Download and install postgres, the database engine Empirical Core uses. The easiest way to get started with this is to download postgres.app.

    If you're more comfortable with installing custom software, you can use homebrew to download and install postgres instead using the following commands:

    1. brew update
    2. brew install postgres
    3. Follow the instructions on the resulting info screen.
  3. Navigate to the directory where you'd like Empirical Core to live, then run the following command to clone the Empirical Core project repository:

    git clone https://github.com/empirical-org/Empirical-Core.git

  4. Use cd Empirical-Core to change directory into the Empirical Core repository.

  5. Install Redis. You can download it directly.

    Alternatively, you can use homebrew to install it by running the following commands:

    1. brew update
    2. brew install redis
  6. Install bundler with gem install bundler.

  7. Install the bundle with bundle install.

  8. Install npm by running brew install npm.

  9. Run rake empirical:setup to automagically get all of your dependencies and databases configured.

  10. You're ready to run Empirical Core!

    1. Run the server using the command foreman start -f Procfile.static.
    2. Navigate your browser to localhost:3000.
    3. When you're done with the server, use Ctrl-C to break it and return to your command line.

Docs

We use GitBook for documentation. To get it set up, run gitbook init and then either gitbook serve (to run the book on a server) or gitbook build (to build a static version of the book). To add docs, create markdown files in the /docs folder and then add a relative link to the file in docs/SUMMARY.md.

Pre-installed user accounts

The installation comes with some pre-populated data to help you get started:

  • A teacher, with username teacher and password password.
  • A student, username student and password password.
  • A staff member, with username staff and password password.

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.