ccfcet / karma

Information Management Framework(HTTP API Service) for Educational Institutions.

Karma

Back-end API framework for colleges.

Motivation

There does not exist a free, open and powerful tool for colleges (specifically higher educational institutes) to enhance and improve processes through the effective management of data. The project aims to provide RESTful HTTP API services alone.

Check out

• Gibbon
• Moodle
• SchoolTool
• RosarioSIS
• Openadmin

and see if any of them meet our needs.

Useful Links

• https://openschoolsolutions.org/
• https://www.schooleducationgateway.eu/en/pub/resources/tutorials/open-source-software.htm

Directory Structure

Design

Details regarding the design and principles followed is available in docs/design folder.

Source Code

Source code available in src folder.

Contributing

Everything is perfect and there is always room for improvement.

Contributions are always welcome and appreciated. Before contributing to this work, kindly ensure that you are aware of the standards and principles that we currently follow. You may fork this repository and add a pull request when you make a good change or addition so that we may review it.

Any contributions including but not limited to material used during communication will be owned by the Central Computing Facility, College of Engineering Trivandrum(CCF CET). By contributing towards this work, you agree that you have proper rights to do the same especially towards transferring ownership of material to CCF CET.

You may feel free to contact us in our mail us at [email protected]

Code of Conduct

See Code of Conduct

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

karma's Issues

Duplication in Data,Table:Student Course Internal Assessment

Entries can be duplicated in the database

Error while running npm install

$ npm install

[email protected] preinstall /Users/santhisenan/Projects/karma/src
rm -rf ./node_modules/_

[email protected] postinstall /Users/santhisenan/Projects/karma/src
./link-modules.sh

npm WARN [email protected] No repository field.

audited 60 packages in 4.853s
found 0 vulnerabilities

[email protected] install /Users/santhisenan/Projects/karma/src/lib/authentication/node_modules/argon2
node-gyp rebuild

CC(target) Release/obj.target/libargon2/argon2/src/opt.o
CC(target) Release/obj.target/libargon2/argon2/src/argon2.o
CC(target) Release/obj.target/libargon2/argon2/src/core.o
CC(target) Release/obj.target/libargon2/argon2/src/blake2/blake2b.o
CC(target) Release/obj.target/libargon2/argon2/src/thread.o
CC(target) Release/obj.target/libargon2/argon2/src/encoding.o
LIBTOOL-STATIC Release/argon2.a
Failed to import the site module
Your PYTHONPATH points to a site-packages dir for Python 2.x but you are running Python 3.x!
PYTHONPATH is currently: "/usr/local/lib/node_modules/npm/node_modules/node-gyp/gyp/pylib"
You should unset PYTHONPATH to fix this.
make: *** [Release/argon2.a] Error 1
gyp ERR! build error
gyp ERR! stack Error: make failed with exit code: 2
gyp ERR! stack at ChildProcess.onExit (/usr/local/lib/node_modules/npm/node_modules/node-gyp/lib/build.js:258:23)
gyp ERR! stack at emitTwo (events.js:126:13)
gyp ERR! stack at ChildProcess.emit (events.js:214:7)
gyp ERR! stack at Process.ChildProcess._handle.onexit (internal/child_process.js:198:12)
gyp ERR! System Darwin 17.5.0
gyp ERR! command "/usr/local/bin/node" "/usr/local/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
gyp ERR! cwd /Users/santhisenan/Projects/karma/src/lib/authentication/node_modules/argon2
gyp ERR! node -v v8.11.2
gyp ERR! node-gyp -v v3.6.2
gyp ERR! not ok
npm WARN [email protected] No repository field.

npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] install: node-gyp rebuild
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] install script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR! /Users/santhisenan/.npm/_logs/2018-06-07T12_41_55_182Z-debug.log
audited 1804 packages in 73.871s
found 9 vulnerabilities (5 low, 4 high)
run npm audit fix to fix them, or npm audit for details

Disallow usage of numbers in name (first, middle and last names) and nationality fields in the people table

Post params:
firstName:123
middleName:111
lastName:A1212
gender:M
dateOfBirth:1997-09-19
nationality:1

Output:
{
"id": 5,
"first_name": "123",
"middle_name": "111",
"last_name": "A1212",
"gender": "M",
"date_of_birth": "1997-09-19",
"nationality": "1",
"updatedAt": "2018-06-04T06:02:40.440Z",
"createdAt": "2018-06-04T06:02:40.440Z"
}

Eslint rules override

Currently, the following rules are overridden.

1. func-names
2. no-console

Should they be overridden?

Call sequelize.sync() from ./bin/www

Refer https://github.com/sequelize/express-example

Removing value column from Student attendance

I don't think there is a need for the value column in student attendance (Assuming it to be either 0 or 1).
We can just store the student who gets attendance for a particular course.

I think this would be better in the long term.

Is use of process.nextTick proper in the codebase?

I am not sure about this subject. Just posting this as an issue in case it improves the quality of work.

Refer https://youtu.be/LbwUETu7Rgc

Convert the names of all files to small letters.

Prevent addition of courses with same course ID in courses_offered. Make necessary schema changes.

Shift to Loopback?

Should we shift the whole platform to Loopback in future?

See https://loopback.io/

Needs analysis.

Placement and Training Module

Is your feature request related to a problem? Please describe.
It would be great if we could manage placement and training information, maybe as a separate module rather than with the core modules.

Describe the solution you'd like
A separate module for managing placement and training information.

Describe alternatives you've considered
Nil

The main website should show the placement information of the current and previous years. (Suggested by Ramesh Panattil, 2014-2018)

Additional context
Add any other context or screenshots about the feature request here.

Documentation for database design

Create documentation for database design.

• Add relevant documentation in MySQL workbench.
• Add documentation for the community to understand the design and improve it.

Enforce FERPA?

Database Design - Change all char(1) to enum

Not compatibile with mariadb

Prevent additiion of multiple same values for people information slugs.

As of now, it is possible to add the same email address for a person twice and it will be reflected in the database, which is undesired
.

Add a field that contains a unique value for all users in the people table.

Composite Key of official_course_id and department_id Needed in courses_offered table

Else it Leads to duplication of courses. @jilvin

Convert data from test.sql to seeders of Sequelize

Currently unable to proceed with it due to a bug in sequelize-cli.

Classestimetable is not unique

Make error messages more descriptive!

Support for Calendar, Projects by individuals and entities

Support for Calendar, Projects by individuals and entities

Content Publishing Support

Is your feature request related to a problem? Please describe.
Add content publishing support to enable easy and flexible content delivery for front-end clients like websites.

Describe the solution you'd like
An additional layer to support easy and flexible content publishing while using existing data models to avoid redundancy and increase data integrity.

Describe alternatives you've considered
No alternative considered.

Additional context
Nil

Add a field to the news_data model to refer to the image associated with a news_data entry.

Is your feature request related to a problem? Please describe.
The news_data model does not have any field to refer to the image associated with a news_data entry.

Describe the solution you'd like
Add an URL field to the news_data model, which can store the URL to the news' image.

Describe alternatives you've considered
Storing URL of the image can be done using the idea of slugs as done for other models.

Additional context
None.

modelCallback in ./src/bin/www

Not sure if this method will cause inconsistencies during startup of the server. Needs thorough analysis and testing. Take support from sequelize community if possible.