/materis

A user-friendly, free & opensource task & productivity management tool for growing startups.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Markdown Here logo

Materis is a task & productivity management application ideal for fast growing startups and small companies.

You can use Materis for

  • Managing and Tracking OKRs
  • Creating, assigning and tracking tasks
  • Maintaining log of time spent by employees
  • Generating different types of reports, and in different formats
  • Analyzing progress and productivity of your company, its departments, teams and employees

License

Materis is released under Apache License 2.0

Installation

Dependencies

  • Ruby 2.1.0
  • MySQL or MariaDB server
  • Imagemagick
  • wkhtmltopdf (To be downloaded from this website and placed in lib folder)

Install bundler and required gems

Once the specified version of Ruby is installed with all its dependencies satisfied, run the following command from the root directory of the application. (You can skip this section if you are using docker)

gem install bundler
bundle install

Configure application

Create and configure database

cp config/database.yml.example config/database.yml

Update the credentials in database.yml with actual values.

Now you can create the database and perform migrations

rake db:create
rake db:migrate

Materis will populate the database with an admin user entry when we run the seed.

rake db:seed

Start the application

You can start the Rails server using

rails server

Materis can be accessed from the browser by navigating to http://localhost:3000.

Initial login credentials:

Email: admin@materis.local

Password: password