Empirical Core is the Learning Management System that powers Quill.org, a free writing tool.
Front End | Back End | Travis CI | Code Climate |
---|---|---|---|
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.
Here's how to get Empirical Core running on your system:
-
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:
brew update
brew install rbenv ruby-build
echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
- Close and reopen your terminal.
-
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:
brew update
brew install postgres
- Follow the instructions on the resulting info screen.
-
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
-
Use
cd Empirical-Core
to change directory into the Empirical Core repository. -
Install Redis. You can download it directly.
Alternatively, you can use homebrew to install it by running the following commands:
brew update
brew install redis
-
Install bundler with
gem install bundler
. -
Install the bundle with
bundle install
. -
Install node via nvm. Run
nvm install
to install the version of node used by this app. -
Install npm by running
brew install npm
. -
Run
rake empirical:setup
to automagically get all of your dependencies and databases configured. -
You're ready to run Empirical Core!
- Run the server using the command
foreman start -f Procfile.static
. - Navigate your browser to localhost:3000.
- When you're done with the server, use Ctrl-C to break it and return to your command line.
- Run the server using the command
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.
The installation comes with some pre-populated data to help you get started:
- A teacher, with username
teacher
and passwordpassword
. - A student, username
student
and passwordpassword
. - A staff member, with username
staff
and passwordpassword
.