classpip/classpip-services repository overview

⁠Classpip Services

Classpip⁠ is a Mobile application for School Gamification. The application is builded around a stack of services and websites to provide a full experience in order to gamificate any educational environment.

This repository contains all the services for accessing the (non)restricted elements of the Classpip data model. This SOA exposes all the methods for querying and managing the Classpip data.

⁠Global dependencies

Make sure you have NodeJS installed. Download the installer here⁠ or use your favorite package manager. It's best to get the 8x version of node along with the 5x version of npm. This offers the best in stability and speed for building.

node -v
> v8.6.0
npm -v
> 5.6.0

You have to install LoopBack⁠ tooling for managing the model:

npm install -g [email protected]

⁠Local Dependencies

All the project dependencies are manage through npmjs⁠. To install this dependenices you should run:

npm install

⁠Running

Start the server (node .) and open localhost:3000⁠ in your browser to view the app.

⁠Testing

To run the tests and code validations you could run:

npm test

⁠Local Database

To configure a local mysql database instead the current in-memory configuration, you should replace the db field by the following lines into the file classpip-services/server/datasources.json:

{
  "db": {
    "host": "localhost",
    "port": 3306,
    "url": "",
    "database": "<database>",
    "password": "<local_user_password>",
    "name": "db",
    "user": "<local_user>",
    "connector": "mysql"
  }
}

⁠License

Classpip is released under the Apache2 License⁠.