School Management API

The backend API for a school management system accessible by staff and students.

Explore the docs »

About The Project

Originally started as a personal project to improve my overall Go knowledge and skills, driven by the complaints of my current school management system for students to view their grades, credits, course selections etc. I took this on as a full project to work on for my Software Engineering class and is now a staple of my work. I plan to work on this till completion, starting with this API, and then the front end, learning new tricks and languages along the way.

I highly recommend looking at the testing for schedule generation, version 3

Future Plans

After the majority completion of vital api functionalities such as the ability to update information, create new information, generate information, delete information, authentication etc. I plan on creating a new repository for a new frontier of this project. I plan on making the School Management Website.

This is most likely going to be written in another programming language or framework I am unfamiliar with. The idea is to have a modern designed website capable of being used easily on any device or platform. I may use the React.js or Vue.js frameworks to build the front end design.

Built With

Getting Started

The systems is easy to start and your local machine. Eliminating any long unforgiving configurations you may face in other software.

Installation

Clone the repo

    $ git clone https://github.com/SowinskiBraeden/school-management-api.git
    $ cd school-management-api

Rename .env.example to .env

Enter desired values into .env

 mongoURI='your mongo URI'
 dbo=school
 secret='your secret'
 PORT='your desired port'
 SYSTEM_EMAIL='your system email'
 SYSTEM_PASSWORD='your system email password'

Run the system in your console

  go run main.go

Build and compile the system into an executable

  go build

Usage

The usage for this API is in the name, school management, it's not an easy task in the areas I live near. Overcrowded schools are far too common and the need for a better school management system is there. The current systems issued by the government work but are poor and outdated.

Contributing

Please refer to CONTRIBUTING for contributing to the project.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Braeden Sowinski - @BraedenSowinski - sowinskibraeden@gmail.com

Project Link: https://github.com/SowinskiBraeden/school-management-api

3.2 KiB Raw Blame History