{"id":20810981,"url":"https://github.com/mrmodise/senepe","last_synced_at":"2025-06-10T13:34:53.788Z","repository":{"id":150701994,"uuid":"63595184","full_name":"mrmodise/senepe","owner":"mrmodise","description":"A photo sharing Web app developed in Spring boot (backend) and Angular 4 (frontend)","archived":false,"fork":false,"pushed_at":"2019-01-16T21:28:16.000Z","size":4839,"stargazers_count":7,"open_issues_count":0,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-07T09:16:19.084Z","etag":null,"topics":["angular","angular-cli","angular4","javascript","spring-boot","spring-security","springframework","stateless","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrmodise.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-18T10:55:37.000Z","updated_at":"2020-04-12T19:55:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"545590a2-9ff0-46f9-baea-ad7133903d10","html_url":"https://github.com/mrmodise/senepe","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmodise%2Fsenepe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmodise%2Fsenepe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmodise%2Fsenepe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmodise%2Fsenepe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrmodise","download_url":"https://codeload.github.com/mrmodise/senepe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmodise%2Fsenepe/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259085402,"owners_count":22803192,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-cli","angular4","javascript","spring-boot","spring-security","springframework","stateless","typescript"],"created_at":"2024-11-17T20:35:20.799Z","updated_at":"2025-06-10T13:34:53.753Z","avatar_url":"https://github.com/mrmodise.png","language":"TypeScript","readme":"[![Packagist](badges/java-v8-red.png)]()  [![Packagist](badges/angular-v4-orange.png)]() [![Badges](badges/orm.png)]()\n\n### Senepe\nSenepe (Tswana language - translated a photo) is a photo sharing Web application. It allows the user to browse through a list of photos upon landing on the site. \nIn the case the user wishes to share photos, the user can register and login to do so. The aim of this project is to demonstrate Angular fundamentals as well as good programming standards. \nThe back-end is developed in Spring boot and front-end is Angular 4. \n\n### Requirements\n1. Internet connection\n2. Editor (WebStorm/Visual Studio Code) - ensure Editor is correctly configured to avoid linting issues.\n3. Angular CLI should be installed (https://cli.angular.io)\n4. NodeJS/npm should be installed (https://nodejs.org)\n5. Knowledge of Terminal or CMD usage\n\n### Setup\n\n- ```$ git clone https://github.com/mrmodise/senepe.git```\n- ``$ yarn install`` to install dependencies. \n\nThe project was generated using ``angular CLI``, as such, providing ``$ ng serve -o`` should compile the project and open ln.\n\n### State Management\nAlthough this is an overkill for such a small application ``:)``, state is managed with Redux (https://github.com/angular-redux/store). Currently, this is a Work-in-progress (WIP).\n\n### Unit Tests\n```$ ng test``` to execute all unit tests. Currently all 70+ tests should execute.\n\nAm busy finishing off the unit tests for all components and services. So far, these are \"completed\":\n\n- LoginComponent\n- RegisterComponent\n- AddPhotoComponent\n- PhotoListComponent\n- AppComponent\n- LoginService\n- PhotoService\n\n### End-to-end Tests\nTo execute e2e tests: ```$ ng e2e```. WIP\n\n### Docker \u0026 Kubernetes\nTo build the Docker image for this app, first build the project ``($ yarn build)`` then image via ``$ docker build -t senepe:1.0 .`` and then ``$ docker run senepe:1.0``.\n I have already built an image, available at \n  https://hub.docker.com/r/mrmodise/senepe/ so you can ``$ docker pull mrmodise/senepe:latest`` and for backend ``$ docker pull mrmodise/backend:1.0``. If you are using Kubernetes to orchestrate your containers' architecture, follow the following commands:\n  \n* ``$ minikube dashboard`` \n* ``$ kubectl create -f backend.yaml`` \n* ``$ kubectl create -f front.yaml`` \n* ``$ minikube service senepe-backend-service`` \n* ``$ minikube service senepe-front-service`` \n  \nMore information on the Docker image for this project: https://hub.docker.com/r/mrmodise/senepe/\n\n### Documentation\nDocumentation for this project has been generated using @Compodoc. This is available under the `documentation` folder. Very useful for understanding the code base.\n\n### Summary \n\n`$ ng serve -o` for a dev server. App will open at `http://localhost:4200/`. \n\nFor back-end code `$ cd backend` and `$ mvn package` to package the back-end code. ``$ java -jar target/senepe-0.0.1-SNAPSHOT.jar`` to execute the back-end code. REST API launches on port 8088. All routes are secured excluding `/auth`\n\nCompleted modules: `registration`, `photo listing`, `login` and `photo uploading`.\n\n`Note` project is still under development. Updated weekly\n\nMore refactoring to be done.....\n\n### License\n```\nThe MIT License (MIT)\n\nCopyright (c) 2016 Mr Mod\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrmodise%2Fsenepe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrmodise%2Fsenepe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrmodise%2Fsenepe/lists"}