EllaNancyFay/Empirical-Core

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

Welcome to Empirical Core!

Fork and Clone this repository to submit a Pull Request

Getting Started: Visit our Community Page

CLA: [Please register an account & sign our CLA.] (http://community.quill.org/signup/cla/)

The Mailing List, Chat, Issues, and Docs can all be accessed from the community page.

Empirical Easy Install

Here is a guide to Empirical Core that makes installation and setup easy.

If you want a simple guide to install Empirical Core, then you've come to the right place! Here's the step-by-step process to get Empirical Core running on your system:

1. Download and install rbenv (or a Ruby version manager of your choice). You need to install Ruby version 2.2.2 to properly use Empirical Core. The best way to do this is follow the README and wiki of whatever Ruby version manager you download, but if you decide to use rbenv, then homebrew has a really great and easy-to-use setup and install process:

2. brew update

3. brew install rbenv ruby-build

4. echo 'eval "$(rbenv init -)"' >> ~/.bash_profile

5. Close and reopen your terminal.

6. 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:

7. brew update

8. brew install postgres

9. Follow the instructions on the resulting info screen.

10. Clone the Empirical Core project. Navigate to whatever directory you'd like Empirical Core to live in, and then use git clone https://github.com/empirical-org/Empirical-Core.git. From here on in, all the commands you have to type should be in the new Empirical Core directory you just downloaded, so you should probably cd Empirical-Core.

11. Install Redis. You can either download it directly, or you can use homebrew instead:

    1. brew update
    2. brew install redis

12. To run js: true/:js-tagged feature specs, install PhantomJS

13. Install bundler with gem install bundler

14. Install the bundle with bundle install.

15. Set up your database with rake empirical:setup.

16. Run Redis with redis-server

17. Run the server with bundle exec rails s.

• Navigate your browser to localhost:3000 and you should see Empirical-Core pull up properly!
• When you're done with the server, use Ctrl-C to break it and return to your commandline.

11. Run bin/guard to have Guard run specs when you save files.

The installation comes with three users, though you can create as many more as you like:

1. A teacher, username teacher and password teacher.
2. A student, username student and password student.
3. An admin, username admin and password admin.
4. An admin, username staff and password staff.

Documentation related to specific features

api controllers

• https://github.com/empirical-org/Empirical-Core/blob/develop/app/controllers/api/README.md

authentication controllers

• https://github.com/empirical-org/Empirical-Core/blob/develop/app/controllers/auth/README.md

cms controllers

• https://github.com/empirical-org/Empirical-Core/blob/develop/app/controllers/cms/README.md

clever integration

• https://github.com/empirical-org/Empirical-Core/blob/develop/app/services/clever_integration/README.md

google integration

• https://github.com/empirical-org/Empirical-Core/blob/develop/app/services/google_integration/README.md