Part 3: Local Set Up

Abre Appathon

Coding Hero Image

Abre’s Community Edition is built on a LAMP stack. For coding an app, you will want to develop on a local machine. While there are a number of ways you can set up an environment, we typically recommend MAMP or WAMP for appathons. This part covers the basics of setting up a local environment (with links to more detailed how-tos).

Download and Install MAMP

  1. Download MAMP: Downloads – MAMP & MAMP PRO
  2. Install MAMP
  3. For instructions on how to install and run MAMP, view their documentation: MAMP, MAMP PRO, NAMO & appdoo Documentation

Download the Community Edition of Abre

  1. Visit Abre’s Community Edition Repository: GitHub – abreio/Abre: The all-in-one education management platform built for improving outcomes and unleashing the potential of everyone in the Learning Community.
  2. Click the green button “Clone or Download”
  3. Download the zip file of Abre.
  4. Navigate to where you saved your Abre ZIP file. The file should be named Abre-master.zip and will more than likely be in your downloads folder.
  5. Extract the file to your downloads directory and you should see a folder named Abre-master.

Move Files to MAMP

  1. Copy all of the contents of this folder into htdocs folder of your MAMP installation. Note: For Windows machines, your htdocs folder will be under My Computer > C:\ > MAMP > htdocs. For Mac machines, your htdocs folder will be under Applications > MAMP > htdocs. Keep your htdocs folder open as we will be adding another file to it in just a minute.
  2. Navigate to where you saved your Abre-Startup ZIP file. The file should be named Abre-Starter-master.zip and will more than likely be in your downloads folder.
  3. Extract the file to your downloads folder and you should see a folder named Abre-Starter-master.
  4. Move the configuration.php file, located under the root directory, to the htdocs directory.

Create an OAuth Project in Google

Abre does not create its own usernames and passwords. Instead, users authenticate with Google or Microsoft. For this example we’re using Google. You will need to create an OAuth project for authentication to work.

View Google’s Documentation on how to set up OAuth 2.0: Setting up OAuth 2.0 – Google Cloud Platform Console Help

Change your Configuration File

  1. Navigate to the configuration.php file.
  2. Open with your preferred editor.
  3. Add Google Client ID (around line 58)
  4. Add Google Console Seccret
  5. Add Google Console API Key

Make Sure MAMP is Running

Note: If you are unsure if MAMP is running, go to your MAMP folder and run the file named MAMP. This will bring up a window showing you the status of your apache and mysql servers. Ensure both boxes are green and continue.

Launch CE Abre on Localhost

  1. Select the “Open start page” options from the MAMP window or navigate to http://localhost/MAMP.
  2. Under the MYSQL section select “phpmyadmin”.
  3. Once you are redirected, select the “Databases” tab located near the top of the page.
  4. Enter “Abre” in the database name field and select “create”.
  5. Next open up an internet browser and navigate to http://localhost/. Here you should see the Abre login screen!
  6. Go ahead and try logging in by selecting “Sign in as Staff”.
  7. Then select “Sign in with Google”

You should now be successfully logged in to your local installation of Abre!