CollBeet Admin

by kalol-institute-of-technology

GitHub Readme.md

CollBeet Admin

CollBeet Admin is a dashboard interface design only for use of Administrators. With CollBeet Admin, admins can easily add student schedules, mess schedules, daily announcements, college locations and college info, which can later be accessed easily using CollBeet Assistant by students (clients). It is designed as a completely open source, free and decentralised software that can be deployed individually on any cloud platform by developer/admin alongside CollBeet Assistant. We have already added support for all major engineering branches and added features that will be very useful for most of college students but feel free to add/change code as per your accordance to make it more suitable for your individual college needs.

For Screenshots click here


Index


Tech Stack

CollBeet Admin is designed & developed using following technologies:

Familiarity with following technologies will also help in further development of CollBeet Admin:


Deployment

GCP Compute Engine Deployment

For production servers and deployment we highly recommend using GCP Compute Engine. You can find further instructions below on how to deploy CollBeet Admin:

Full Guide

Heroku Deployment

Just click the following button to deploy CollBeet Admin on a Heroku Server. However due to higher cost we only recommend Heroku only if you are planning to use this server for testing purposes. For production, we highly recommend GCP Compute Engine Deployment.

Deploy

Change Admin Password

CollBeet Admin after deployment will be setup by default with following Admin credentials:

Username: admin
Password: admin

You can change Change Admin Password to whatever you like, using the Change Password button, located on the upper left hand side corner of the dashboard.

Development

Even though CollBeet Admin is designed as a ready to use software, it is possible that your college has some different requirements than vanilla version. Because this is an open source and our very friendly MIT License, feel free to change/add code as per your requirements. Refer to following points to know more on how to do it.

Developer Environment Setup

Setting up Developer Environment for CollBeet Admin is super easy, make sure you have all following required prerequisites installed on your machine and follow the given steps:

Prerequisites

Steps:

  1. Fork this repository.

  2. Once the repository is forked, clone the repository on you local machine using Git CLI and your forked repo URL.

    git clone your-repo-url

  3. Change to root directory.

    cd CollBeet-Admin

  4. Install all project dependecies.

    meteor npm install

  5. Run a local development server using following command.

    meteor

Server should start now and will be running on http://localhost:3000. Any changes you make to your code will be updated automatically.

REST API Endpoints

REST API Endpoints are used by CollBeet-Assistant to communicate with CollBeet-Admin. You can access any of this endpoints, on your browser or Postman. For ex: If you have a localhost server and want to access student endpoint just write following URL: http://localhost:3000/api/student

Url Short Description /api/student Gets all added lectures and departments. /api/mess Gets all added meals from mess section. /api/announcements Gets added announcments. /api/info Gets added general information about college. /api/locations Gets all added location info about college.