Update README.md
This commit is contained in:
1 parent
40886aa815
commit
bbe4ecf705
1 file changed
+25
-8
@@ -11,6 +11,13 @@ The backend API for a school management system accessible by staff and students.
|
|||||||
<br>
|
<br>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
### Built With
|
||||||
|
|
||||||
|
* [Golang](https://go.dev/)
|
||||||
|
* [GoFiber](https://gofiber.io/)
|
||||||
|
* [GoMongo Driver](https://docs.mongodb.com/drivers/go/current/)
|
||||||
|
* [golang-jwt](https://github.com/golang-jwt/jwt)
|
||||||
|
|
||||||
## About The Project
|
## About The Project
|
||||||
|
|
||||||
Originally started as a personal project to improve my overall Go knowledge and skills, driven by the complaints
|
Originally started as a personal project to improve my overall Go knowledge and skills, driven by the complaints
|
||||||
@@ -19,8 +26,23 @@ this on as a full project to work on for my Software Engineering class and is no
|
|||||||
work on this till completion, starting with this API, and then the front end, learning new tricks and languages
|
work on this till completion, starting with this API, and then the front end, learning new tricks and languages
|
||||||
along the way.
|
along the way.
|
||||||
|
|
||||||
I highly recommend looking at the testing for [schedule generation](/test/scheduleGenerator), version 3.
|
Developing the API has has me face many challenges. With me developing my techniques in Go, and increasing my
|
||||||
Though this has been moved to its own [repository](https://github.com/SowinskiBraeden/schedule-generator).
|
ability to work with Go frameworks. Understanding the workflow of packages and the Go ecosystem.
|
||||||
|
|
||||||
|
I started by developing authentication; a solid footing to the project, without the authentication of users,
|
||||||
|
the rest of the project would fail to work. As the purpose of this API handles sensitive data on students.
|
||||||
|
|
||||||
|
Once the authentication was complete, I took to working on majority of the user data handling. Such as
|
||||||
|
setting, updating and or deleting user attributes. Building a few more key authentication features only
|
||||||
|
allowing the proper authenticated user, an admin, perfom many of the actions.
|
||||||
|
|
||||||
|
Once this was complete I started work on conceptualizing the next major step of the API. Course management,
|
||||||
|
including course selection, schedule generation, etc. This can be viewed in this [request](https://github.com/SowinskiBraeden/school-management-api/issues/5).
|
||||||
|
To start off on this new set of features, I decided to tackle the largest and most complex problem,
|
||||||
|
schedule generation. This algorithm generates a master timetable as well as updates the student schedule.
|
||||||
|
All the while keeping track of any errors for admins to handle personally. This can be found in `testing`,
|
||||||
|
The [schedule generation](/test/scheduleGenerator) file is of the latest version, version 3. Though this has
|
||||||
|
been moved to its own [repository](https://github.com/SowinskiBraeden/schedule-generator).
|
||||||
|
|
||||||
## Related Work
|
## Related Work
|
||||||
|
|
||||||
@@ -33,12 +55,6 @@ was to use Vue.js, and I started work on the project, which I have now decided t
|
|||||||
suited for this project and is more popular with its use of React.js over Vue.js. The new repository can be found [here](https://github.com/SowinskiBraeden/school-management).
|
suited for this project and is more popular with its use of React.js over Vue.js. The new repository can be found [here](https://github.com/SowinskiBraeden/school-management).
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
### Built With
|
|
||||||
|
|
||||||
* [Golang](https://go.dev/)
|
|
||||||
* [GoFiber](https://gofiber.io/)
|
|
||||||
* [GoMongo Driver](https://docs.mongodb.com/drivers/go/current/)
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
The systems is easy to start and your local machine. Eliminating any long unforgiving configurations you may face in other software.
|
The systems is easy to start and your local machine. Eliminating any long unforgiving configurations you may face in other software.
|
||||||
@@ -110,5 +126,6 @@ Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
|
|||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
Braeden Sowinski - [@BraedenSowinski](https://twitter.com/BraedenSowinski) - sowinskibraeden@gmail.com
|
Braeden Sowinski - [@BraedenSowinski](https://twitter.com/BraedenSowinski) - sowinskibraeden@gmail.com
|
||||||
|
McDazzzled#5307 on Discord
|
||||||
|
|
||||||
Project Link: [https://github.com/SowinskiBraeden/school-management-api](https://github.com/SowinskiBraeden/school-management-api)
|
Project Link: [https://github.com/SowinskiBraeden/school-management-api](https://github.com/SowinskiBraeden/school-management-api)
|
||||||
Reference in new issue
Block a user