A grammar and vocab learning platform for schools.

Students will love Grammarer - it offers a fun and super-simple solution to revising both grammar and vocab in a portable and modern way. Admins will also love it for its simplicity and easy setup process.

Grammarer is fully customisable. Every colour. Every icon. Every title. Everything can be changed using the gm-options.json file.

Grammarer has a full user management system, powered by MongoDB. Each user is given a 1-7 digit code made of letters and/or numbers and is assigned to a cohort (a class) of other students. The cohort can then be assigned lists to access. This allows students to store their progress on the server and access averages and graphs to see their improvement. Teachers can assign new codes and delete ones they don't need. They can even auto-generate a sheet of 16 printable codes.

As mentioned earlier, Grammarer is completely customisable. You can make it look however you want. Your own colours, pictures and text.

Grammarer is extremely simple to set up, but you'll need some basic knowledge of JavaScript and the command line, as well as a server to run it on. You'll also need to be relatively experienced with MongoDB as you will need to be handling Mongo queries to add grammar/vocab lists.

1. First, make sure NodeJS is installed. You can try by running node -v in a command line. It should return something similar to v8.9.4. If not, visit the NodeJS download page and download it. It comes pre-packaged with NPM, which is also required for running Grammarer.

2. Make sure MongoDB is installed and running. MongoDB is required to control the database of Grammarer. You can either host it locally (see this) or through Mongo Atlas

3. Enter the directory that you want to contain the Grammarer source files in, and run:

git clone https://github.com/palkerecsenyi/grammarer.git

4. Enter the directory that the files were cloned into, and run:

npm install

5. Open gm-options.json with your favourite text editor. Here is what it should look like:

{
  "organisation": {
    "name": "Example School",
    "logo": "img/example_school.png",
    "primaryColour": "#5fe85a",
    "secondaryColour": "#4fbc4b",
    "aboutPage": true
  },
  "rootUrl": "localhost",
  "ports":{
    "development": "3000",
    "production": "80"
  },
  "dbString": "mongodb://localhost:27017",
  "features": [
    "grammar",
    "vocab",
    "printables"
  ],
  "languages": [
    "greek"
  ],
  "printables": [
    {
      "language": "Greek",
      "name": "Adjectives",
      "fileName": "y9_gratin_greek_adj.pdf"
    },
    {
      "language": "Greek",
      "name": "Definite Article",
      "fileName": "y9_gratin_greek_defart.pdf"
    }
  ]
}

5. Edit the file to match your needs.

1. Once you have made the appropriate changes to gm-options.json and removed unnecessary demo data, you can run the automatic build script. Just simply type:

node setup.js

2. If this completes without error, you are ready to start the Grammarer server. If you do encounter an error, it will probably explain the issue and where it ocurred. To start the server, type:

npm start
# or
npm run start-dev

3. That's it! Visit the URL it shows in a web browser and sign in with the default code 'admin'. You can then access the 'Magic Dashboard' to create new users.

You can choose to customise Grammarer using the gm-options.json file. The organisation object contains most customisation options:

However, these options may not be sufficient for you. In this case, you can start by editing the four CSS files in frontend:

On top of this, you can also change the HTML files in frontend/views or the main view container in frontend/index.html. Satisfied now?

All lists are defined in the lists collection within the grammarer-db database. If this doesn't exist (it isn't created by default), you will need to add it manually. It's easiest to do this through Mongo Compass, a desktop MongoDB client. You will also need the MongoDB CLI to insert large JSON objects in their original format.

Grammar and vocab lists can now be added through a simple and friendly GUI by an admin user. Simply sign in and click Magic Dashboard > Create and manage grammar/vocab lists > Add grammar list/Add vocab list.

Grammar and vocab lists have slightly different structures so they are explained separately.

You can see an example here.

The object starts with some global definitions to identify the list:

Next, you need to define the maxPosition array. This contains two integers, depending on which way you want the cursor to move through the list when it is practised:

Finally, you need to define the actual table itself, using the table key, which contains an object.

Vocab checklists are much simpler to build, as they only involve two definitive columns. They start with the same general definitions as in the first table of the Grammar list.

An example is available here

Instead of the maxPosition array, you need to use vocabLength to define the linear length of the vocab list - this should be an integer.

Instead of the table property, you need to use the list array to define items. Each item in this array should be an object, containing two values:

When playing the vocab is a normal user, the two languages can be easily swapped around using the Swap languages button.

All user control can be done through the 'Magic Dashboard'. You can access this by clicking the small link at the bottom of the page shown to you once you sign in. Only users with the role teacher or admin can access the dashboard.

In Grammarer, a cohort represents a class of students and teacher(s). For example, a cohort could be y9_german_1. Most schools have their own naming convention for classes, which they can use easily with Grammarer. Every user belongs to a cohort, and only one cohort. If a teacher teaches multiple classes or a student takes multiple classes, they will need separate codes for each. By default, the admins cohort is created and the admin user is placed inside it. Both of these should be deleted immeadiately in order to avoid security issues.

The default user can enter the dashboard and use the various tools, tabs and modals to create, delete and modify users and cohorts.

Grammarer is licensed under the MIT license, available here. Any contribution is welcome and everything will be considered.

Grammarer would not be possible without:

• Bulma.io CSS framework
• AngularJS + router + animate
• Cfp-Angular-Loading-bar
• jsPdf PDF generator
• jQuery
• NodeJS
• MongoDB
• Mocha