{"id":26245982,"url":"https://github.com/devhanza/school-notes-angular","last_synced_at":"2025-12-26T17:34:44.336Z","repository":{"id":264674634,"uuid":"884203312","full_name":"DevHanza/school-notes-angular","owner":"DevHanza","description":"MEAN Stack Application for taking notes for students. (MongoDB, Angular, Express.js, Node.js)","archived":false,"fork":false,"pushed_at":"2024-11-25T17:07:43.000Z","size":1276,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-13T13:17:02.056Z","etag":null,"topics":["angular","expressjs","mean-stack","mongodb","nodejs","notes-app","simple-project"],"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/DevHanza.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":"2024-11-06T10:36:29.000Z","updated_at":"2024-12-09T10:32:11.000Z","dependencies_parsed_at":"2024-11-25T18:20:37.418Z","dependency_job_id":"737fe1d6-75df-4898-bfb4-4fe0775e05e7","html_url":"https://github.com/DevHanza/school-notes-angular","commit_stats":null,"previous_names":["devhanza/school-notes-angular"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DevHanza/school-notes-angular","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevHanza%2Fschool-notes-angular","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevHanza%2Fschool-notes-angular/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevHanza%2Fschool-notes-angular/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevHanza%2Fschool-notes-angular/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DevHanza","download_url":"https://codeload.github.com/DevHanza/school-notes-angular/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevHanza%2Fschool-notes-angular/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28057624,"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","status":"online","status_checked_at":"2025-12-26T02:00:06.189Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","expressjs","mean-stack","mongodb","nodejs","notes-app","simple-project"],"created_at":"2025-03-13T13:17:03.962Z","updated_at":"2025-12-26T17:34:44.288Z","avatar_url":"https://github.com/DevHanza.png","language":"TypeScript","readme":"\u003ch1 align=center\u003eSchoolNotes\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://hansana.is-a.dev\"\u003e\n    \u003cimg src=\"https://skillicons.dev/icons?i=mongodb,express,angular,nodejs\" alt=\"MEAN Stack Technologies\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eA Simple Note-Taking Application for Students\u003c/h3\u003e\n\n![SchoolNotes Screenshot](https://github.com/user-attachments/assets/466fca57-3a58-41c4-b645-ba91f6a5b81f)\n\n## Features\nWith SchoolNotes, you can:\n- Create notes\n- Read notes\n- Edit notes\n- Delete notes\n- Categorize notes\n- Search notes\n- Add new categories\n- Edit category settings\n\nAdditional highlights:\n- Mobile-friendly design\n- Scalability with a MongoDB database\n- Super-fast note searching\n- Faster loading times\n\n## How to Use\nWatch this quick video tutorial to see how to use SchoolNotes:\n[Watch the video](https://youtu.be/m-1DHXa-0FI)\n\n### Project Structure\nThe project folder consists of two main directories:\n\n- **`client`**: The front-end application built using [Angular](https://angular.dev/).\n- **`server`**: The back-end REST API built with [Express.js](https://expressjs.com/), [Node.js](https://nodejs.org/en), and [MongoDB](https://mongodb.com/). The server uses the MongoDB native driver for efficient database operations.\n\nThe `server` acts as the REST API for the `client`. For the application to function properly, both the `client` and `server` need to run simultaneously. While a concurrent package is used for local development convenience, it is important to host each part separately in a production environment for better performance and scalability. Check out the [How to Host in Production](#how-to-host-this-on-production-environment) section for detailed guidance.\n\n## How to Run It Locally\nFollow these steps to set up and run the application on your computer:\n\n### Prerequisites\n1. Install the following software:\n   - [Git](https://git-scm.com/downloads)\n   - [Node.js](https://nodejs.org/en)\n   - [Mongosh](https://www.mongodb.com/try/download/shell)\n\n2. Create a free MongoDB Cluster by following this tutorial:  \n   [How to Create a MongoDB Cluster](https://youtu.be/VkXvVOb99g0)\n\n### Setup\n1. Navigate to the `../school-note-angular/server` folder.\n2. Rename the `.example.env` file to `.env`.\n3. Update the `MDB_URL` field in the `.env` file with your MongoDB URI. Example:\n\n   ```env\n   MDB_URL=mongodb+srv://username:password@cluster.mongodb.net/?retryWrites=true\u0026w=majority\u0026appName=yourAppName\n   ```\n\n### Run in on your computer\n1. Open your terminal and execute the following commands (this process may take 5-15 minutes):\n   ```bash\n   git clone https://github.com/DevHanza/school-notes-angular.git\n   cd school-notes-angular\n   npm run start\n   ```\n2. Once the setup is complete, a link will appear in the terminal. Open this link in your browser to use the application.\n3. To stop the application, press `CTRL + C` in the terminal.\n4. Done! ✅\n\n## How to Host This on Production Environment\nTo host SchoolNotes in a production environment, follow these steps:\n\n1. **Host the Client**:\n   - Build the Angular application using the command:\n     ```bash\n     cd client\n     ng build\n     ```\n   - Serve the built files using a web server like Nginx or Apache.\n\n2. **Host the Server**:\n   - Use a Node.js process manager like PM2 to manage the server:\n     ```bash\n     cd server\n     pm2 start server.js\n     ```\n   - Ensure the server is accessible via a public IP or domain name.\n\n3. **Database Configuration**:\n   - Use a managed MongoDB service like [MongoDB Atlas](https://www.mongodb.com/products/platform/atlas-database) for scalable and secure database hosting.\n\n4. **Environment Variables**:\n   - Securely configure the server's environment variables (e.g., `MDB_URL`).\n\n\n## Need Help?\nIf you encounter any issues, feel free to contact me on [LinkedIn](https://www.linkedin.com/in/devhanza/).\n\n---\n\nSchoolNotes is built using the MEAN stack:\n- [MongoDB](https://www.mongodb.com)\n- [Express.js](https://expressjs.com)\n- [Angular CLI](https://github.com/angular/angular-cli)\n- [Node.js](https://nodejs.org)\n\n### Inspiration\nThis project was inspired by [CS50x](https://cs50.harvard.edu/x/2024/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevhanza%2Fschool-notes-angular","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevhanza%2Fschool-notes-angular","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevhanza%2Fschool-notes-angular/lists"}