Docimer Documentation


Installation

To get started on a Windows local machine:

  • first download the rails installer. Just like WordPress where you need LAMP (for Linux) or WAMP (for Windows, A: Apache, M: MySql, P: PHP), for Docimer, you'll need the rails installer.

  • Next Step: you have to clone the Docimer app from the GitHub repository, or download the zip version (remember to unzip). For Windows user, create a folder called sites in the root of your machine (e.g C:\Sites ). Place you docimer folder in there (e.g. C:\Sites\docimer ). It can be anywhere, but for the sake of this tutorial, we'll leave it there.

  • Now, we've installed the rails installer, and have a copy of Docimer in the sites folder in the C: drive. Now, lets start the ruby on rails server. Follow these steps =>

    In the command prompt (for Windows) =>

    cd \sites/docimer
    bundle install
    rails db:migrate
    rails s
  • And that's it for Windows. Head over to a a browser and load =>

    http://localhost:3000

    You should see Docimer running (probably a blank page with a header & footer). To sign up =>

    http://localhost:3000/cmsadmins/sign_up

    To sign in =>

    http://localhost:3000/cmsadmins/sign_in





  • For Linux:

  • follow the rails installer steps for Linux (from the rails installer site). On my end, I prefer using RVM to install Rails on Linux (mostly Ubuntu).

  • Next Step: you have to clone the Docimer app from the GitHub repository, or download the zip version (remember to unzip). I'll assume your folder is in /home/[username]/sites/docimer. It can be anywhere, but for the sake of this tutorial, we'll leave it there.For me, its in /home/ubuntu/sites/docimer

  • Now, we've installed Ruby on Rails, and have a copy of Docimer in the sites folder in the C: drive. Now, lets start the ruby on rails server. From your Docimer folder =>

    In the terminal (for Linux) =>

    bundle install
    rails db:migrate
    rails s
  • And that's it for Linux. Head over to a a browser and load =>

    http://localhost:3000

    NB: if its on a Cloud Server e.g. AWS Ec2, remember to open port 3000 in the Security Group.

    You should see Docimer running (probably a blank page with a header & footer). To sign up =>

    http://localhost:3000/cmsadmins/sign_up

    To sign in =>

    http://localhost:3000/cmsadmins/sign_in


  • Using Docimer

    At this point, we have Docimer installed and running on localhost port 3000.Follow the link below to login to the cms admin interface =>

    http://localhost:3000/cmsadmin/sign_up


    Create your new admin account and you should be redirected to the home page with a side bar. The side bar has everything you'll require to build the site from start to finish.