{"id":13316407,"url":"https://github.com/okkibro/anti-bubble-app","last_synced_at":"2025-03-10T23:31:47.210Z","repository":{"id":38476940,"uuid":"292098259","full_name":"okkibro/anti-bubble-app","owner":"okkibro","description":"A MEAN Stack (Mongo, Express, Angular, Node) application that teaches children about filter bubbles.","archived":false,"fork":false,"pushed_at":"2023-01-11T04:26:54.000Z","size":77697,"stargazers_count":0,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-07T01:06:46.007Z","etag":null,"topics":["angular","application","express","material-design","mean-stack","mongoose","nodejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/okkibro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-01T20:15:30.000Z","updated_at":"2020-09-02T17:11:40.000Z","dependencies_parsed_at":"2023-02-09T01:45:27.885Z","dependency_job_id":null,"html_url":"https://github.com/okkibro/anti-bubble-app","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okkibro%2Fanti-bubble-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okkibro%2Fanti-bubble-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okkibro%2Fanti-bubble-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okkibro%2Fanti-bubble-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/okkibro","download_url":"https://codeload.github.com/okkibro/anti-bubble-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242944824,"owners_count":20210708,"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","application","express","material-design","mean-stack","mongoose","nodejs"],"created_at":"2024-07-29T18:21:38.324Z","updated_at":"2025-03-10T23:31:47.201Z","avatar_url":"https://github.com/okkibro.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Anti Bubble App \n\n### Documentation\n\nDocumentation is hosted on the GitHub Pages website belonging to this repository (can be visited at https://okkibro.github.io/anti-bubble-app/). The \ndocumentation is exclusively for the front-end of the app (about 85% of the code) and is divided into 4 main sections, \nwhich correspond to the 4 folders found in the ```./src/app``` folder of the app. The folders are as follows:\n+ ```Components``` - TypeScript components describing all the pages/components/classes of the app.\n+ ```Models``` - TypeScript representations of all custom classes/enums used in the app, based on their MongoDB back-end counterparts.\n+ ```Services``` - TypeScript services mainly used for HTTP requests for communicating with the Node.js/Express back-end.\n+ ```Shared``` - Remaining files/services/functions used by the app.\n\n### Generating TypeDocs\nAll ```*.ts``` files in the ```./src/app``` folder of the project have TypeDoc comments. \nTo automatically generate docs use the ```typedoc --options typedoc.json``` command after having merged the new code into the ```gh-pages``` branch and \nhaving checked out that branch. After pushin the new docs to the repository, the GitHub Pages will automatically rebuild and incorporate the new changes.\n\nMake sure the ```_config.yml``` file in the root of the project is also located in the root of the by TypeDoc generated ```./docs``` folder, \notherwsie GitHub Pages will not work.\n\n### Folder structure\n\n+ **/src**: *Angular app created using ```angular/cli```.*\n+ **/database**: *Contains mongoose Schemas*\n+ **/server**: *Files to be used on server-side*\n    * **/routes**: *Declared routes to be imported on ```index.js```*\n+ **/index.js**: *File that is used to start the node server*\n\n### Prerequisites\n\n+ **[Node.js \u0026 npm](https://nodejs.org/en/download/)**: *Please be sure you have installed Node.js and npm module on your computer before running the application*\n+ **[MongoDB](https://www.mongodb.com/download-center)**: *Download \u0026 Install MongoDB, and make sure it's running on the default port (27017).*\n+ **[AngularCLI](https://cli.angular.io/)**: *Is used to build front-end application. Use [npm install -g @angular/cli] to install this*\n\n### First time usage\n\n+ Clone repository from https://git.science.uu.nl/breaking-bubbles/anti-bubble-app.git\n    + Can be done by using the *git clone [url]* function with **[Git](https://git-scm.com/)**\n+ Acquire the \".env\" file from the secret holder and add this to the root of the application\n+ Be sure you have started MongoDB service before running the application\n+ Navigate to project folder\n+ Run ```npm install``` on your folder\n+ Run ```ng build``` on here to generate Angular necessary files. Output files are by default created on ```/dist``` subfolder\n+ Now run ```node index.js``` This is the last step and if everything goes right, server will start listening for requests\n    + You can also install **[nodemon]** (```npm install -g nodemon```) to have auto refresh when working on the backend\n    + When you work on the frontend and you want auto refresh use ```npm start```\n+ You can open your browser and navigate to localhost:4200 to see if application works\n\n### Normal usage\n+ Be sure you have started MongoDB\n+ Navigate to project folder\n+ Run ```npm start```\n+ Open browser and navigate to localhost:4200\n\n### Running test locally\n+ Run ng test --code-coverage --browsers=Chrome\n+ Updates automatically on save\n\n### Branches\n\n#### Hot Fix\n+ git checkout master\n+ git checkout -b hotfix_branch\n\n** work is done commits are added to the hotfix_branch*\n\n+ git checkout develop\n+ git merge hotfix_branch\n+ git checkout master\n+ git merge hotfix_branch\n\n#### Feature\n+ git checkout master\n+ git checkout -b develop\n+ git checkout -b feature_branch\n\n** work happens on feature branch *\n\n+ git checkout develop\n+ git merge feature_branch\n+ git checkout master\n+ git merge develop\n+ git branch -d feature_branch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokkibro%2Fanti-bubble-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fokkibro%2Fanti-bubble-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokkibro%2Fanti-bubble-app/lists"}