/meglish

Epicodus: Rails Final Project - English Language Learning Platform

Primary LanguageHTML

Meglish

By Meaghan Jones

Meglish allows a user to organize lessons into courses. A course page lists all of the lessons and each lesson has specific information related to that lesson on its page. At the bottom of each lesson are navigation links to the course index.

Courses and lessons can be deleted or edited and more can be added. The application is intended to help english teachers create lessons for English learners in a well structured way.

Technologies Used

  • Ruby on Rails 5
  • Rspec, Capybara
  • Database: Postgres, ActiveRecord

Configuration


Install Meglish by cloning the repository.

$ git clone https://github.com/meaghanjones/meglish

Check to make sure ruby and rails are installed on your machine.

$ ruby -v
$ rails -v

If they are not installed, please follow instructions here to install ruby on rails.
Navigate to project file

$ cd meglish

Install required gems

$ bundle install

Run Postgres

$ postgres

Create database, Load the schema and seed the database

$ rake db:create db:schema:load db:seed

Start the Rails web server and navigate to localhost:3000 in a browser:

$ rails server

Special set up with Google maps API key

In order to view the map on the locations page of this project you must have a Google API key. In order to get this key navigate to https://developers.google.com/maps/documentation/javascript/get-api-key and login to your Google account. Follow along with the instructions and push the get a key button and setup a project that can be linked to the API key they give you. After enabling the API create a .env file in the root of the project directory and save the key following the code below:

MAP_API_KEY=YOUR KEY HERE

License

This software is licensed under the MIT license. Copyright (c) 2016 Meaghan Jones