├── go.mod ├── .gitignore ├── LICENSE └── README.md /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/Ubn-Jr/hirob-be-core 2 | 3 | go 1.21.0 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # If you prefer the allow list template instead of the deny list, see community template: 2 | # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore 3 | # 4 | # Binaries for programs and plugins 5 | *.exe 6 | *.exe~ 7 | *.dll 8 | *.so 9 | *.dylib 10 | 11 | # Test binary, built with `go test -c` 12 | *.test 13 | 14 | # Output of the go coverage tool, specifically when used with LiteIDE 15 | *.out 16 | 17 | # Dependency directories (remove the comment below to include it) 18 | # vendor/ 19 | 20 | # Go workspace file 21 | go.work 22 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Ubn-Jr 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # HiROB 2 | 3 | This GitHub repository hosts the foundational backend components of the HiROB project, consisting of a RESTful API designed for seamless interaction with both the HiROB frontend and the HiROB robot. The core-backend will be developed using the [Go programming language](https://go.dev/learn/). 4 | 5 | ## What is HiROB? 6 | 7 | HiROB is an educational initiative dedicated to enhancing children's arithmetic intelligence by offering an engaging and effective learning experience in the realms of algorithms, coding, and software development. 8 | 9 | ## TODO List for the Project's Backend Part (Phase 1) 10 | 11 | - [x] 1. Discuss the project's backend structure and select the tools. 12 | - [ ] 2. Create a RESTful API using the designated framework. 13 | - [ ] 3. Discuss the project's database structure with other teams and select the tools. 14 | - [ ] 4. Create a Dockerfile. 15 | - [ ] 5. Create a database scheme. 16 | - [ ] 6. Create database models. 17 | - [ ] 7. Create database migrations. 18 | - [ ] 8. Create middlewares. 19 | - [ ] 9. Create routes for front-end communication. 20 | - [ ] 10. Create handlers for front-end routes. 21 | - [ ] 11. Create routes for MQTT communication. 22 | - [ ] 12. Create handlers for MQTT routes. 23 | - [ ] 13. Test the API's endpoints. 24 | 25 | ## Stack 26 | 27 | - [Go](https://go.dev/learn/) 28 | - [Web Framework (Gin)](https://gin-gonic.com/) 29 | - [Authentication (JWT)](https://github.com/golang-jwt/jwt) 30 | - [Authorization (RBAC)](https://github.com/casbin/casbin) 31 | - [Database (PostgreSQL)](https://www.postgresql.org/) 32 | - [ORM (GORM)](https://gorm.io/) 33 | 34 | ## As the backend team, our objective is to achieve the following goals 35 | 36 | 1. **Design and Implement Scalable Infrastructure:** Ensure the server infrastructure scales efficiently to meet the demands of the users and services. 37 | 38 | 2. **Ensure Data Integrity and Security:** Safeguard all user data, making certain it's not only secure from potential threats but also stored accurately and consistently. 39 | 40 | 3. **Provide Seamless Integration:** Develop robust and versatile APIs that allow for easy integration with the frontend and any other potential external systems or services. 41 | 42 | 4. **Maintain High Availability and Performance:** Ensure that the backend services remain available with minimal downtime and respond swiftly to user requests. 43 | 44 | 5. **Facilitate Continuous Integration/Continuous Deployment (CI/CD):** Implement processes that allow for continuous integration and deployment of backend features and fixes, ensuring the most recent and stable version of the system is always live. 45 | 46 | 6. **Stay Updated and Innovate:** Continually learn about the latest technologies and best practices in backend development and consider how they might be implemented to improve our system. 47 | 48 | 7. **Collaborate and Communicate:** Work closely with other teams, especially the frontend team and the operations team, to ensure that there's clear communication and alignment in terms of requirements, implementations, and deployments. 49 | 50 | - By achieving these goals, we aim to provide a reliable, efficient, and effective backend that powers the entire application ecosystem. 51 | 52 | ## LICENSE 53 | 54 | ![GitHub](https://img.shields.io/github/license/UBN-jr/hirob-be-core?style=for-the-badge) 55 | 56 | ## TEAM 57 | 58 | [Dilara DOĞAN](https://github.com/Sddilora) ( Team Leader ) 59 | 60 | [Hüsamettin ARABACI](https://github.com/husamettinarabaci) ( Senior Developer ) 61 | 62 | [Amine GÜNEŞ](https://github.com/gnsamine) 63 | 64 | [Furkan ADIGÜZEL](https://github.com/furkanadiiguzel) 65 | 66 | [Merve GÖNCÜ](https://github.com/mervegonc) 67 | 68 | [Furkan KAYAPINAR](https://github.com/johsquaree) 69 | 70 | [Feyza Nur ŞAHİN](https://github.com/Feyzanrs) 71 | 72 | ![GitHub contributors](https://img.shields.io/github/contributors/UBN-jr/hirob-be-core?style=for-the-badge) --------------------------------------------------------------------------------