{"id":49182558,"url":"https://github.com/simple-works/notes","last_synced_at":"2026-04-23T02:03:47.881Z","repository":{"id":48609875,"uuid":"258310726","full_name":"simple-works/notes","owner":"simple-works","description":"📝 Public Notes Sharing Web Application.","archived":false,"fork":false,"pushed_at":"2021-07-22T10:11:50.000Z","size":5533,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-07-17T02:47:32.723Z","etag":null,"topics":["backend","express","frontend","nodejs","note-taker","note-taking","note-taking-app","notes","notes-app","online-note","social-network","template","template-project","vue","vuejs"],"latest_commit_sha":null,"homepage":"https://amb-notes.herokuapp.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simple-works.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-04-23T19:33:57.000Z","updated_at":"2023-06-15T01:29:01.000Z","dependencies_parsed_at":"2022-09-06T01:41:16.826Z","dependency_job_id":null,"html_url":"https://github.com/simple-works/notes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/simple-works/notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simple-works","download_url":"https://codeload.github.com/simple-works/notes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32162614,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T17:06:48.269Z","status":"online","status_checked_at":"2026-04-23T02:00:06.710Z","response_time":53,"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":["backend","express","frontend","nodejs","note-taker","note-taking","note-taking-app","notes","notes-app","online-note","social-network","template","template-project","vue","vuejs"],"created_at":"2026-04-23T02:03:39.242Z","updated_at":"2026-04-23T02:03:47.860Z","avatar_url":"https://github.com/simple-works.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![Icon](./icon.png?raw=true) Amb-Notes\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Ambratolm/amb-notes/Node.js%20CI?logo=github)](https://github.com/Ambratolm/amb-notes/actions/workflows/node.js.yml)\n[![Web](https://img.shields.io/badge/web-blue?logo=w3c)](https://github.com/topics/web)\n[![JavaScript](https://img.shields.io/badge/javaScript-blue?logo=javascript)](https://github.com/topics/javascript)\n[![VueJS](https://img.shields.io/github/package-json/dependency-version/Ambratolm/ambratolm-web/vue?logo=vue.js)](https://github.com/topics/vuejs)\n[![Bulma](https://img.shields.io/github/package-json/dependency-version/Ambratolm/ambratolm-web/bulma?logo=bulma)](https://github.com/topics/bulma)\n\nPublic Notes Sharing Web Application.\n\n[**🌐 View Live Demo**](https://amb-notes.herokuapp.com)\n\n\u003c!-- ![amb-notes-screenshot](/screenshot.gif?raw=true \"Screenshot of the app\") --\u003e\n\n## 📖 Table of contents\n\n\u003c!-- toc --\u003e\n\n- [📜 Introduction](#-introduction)\n- [🏁 Getting started](#-getting-started)\n- [✈️ Deployment](#-deployment)\n- [📐 Design](#-design)\n- [🚀 Development](#-development)\n  - [🏭 Environment](#-environment)\n  - [🌕 Frontend](#-frontend)\n  - [🌑 Backend](#-backend)\n\n\u003c!-- tocstop --\u003e\n\n## 📜 Introduction\n\nThis is a simple **Web application** that allows users to **post public notes** that others can see on the home page. \u003cbr\u003e\nIt is mainly built with **VueJS** and **ExpressJS**. It implements many **common features** using many **libraries**. \u003cbr\u003e\nThis project can be used for **learning purposes** or as a **starter template** for building similar applications.\n\n## 🏁 Getting started\n\n1. Clone the repository:\n\n```bash\ncd somewhere\ngit clone https://github.com/Ambratolm/amb-notes.git\ncd amb-notes\n```\n\n2. Install the dependencies:\n\n```bash\nnpm i\n```\n\n3. Install [**Nodemon**](https://github.com/remy/nodemon/) globally:\n\n```bash\nnpm i -g nodemon\n```\n\n4. Run app server:\n\n```bash\nnpm run serve\n```\n\n4. Run api server:\n\n```bash\nnpm run api\n```\n\n## ✈️ Deployment\n\nTo deploy the project in a node environment:\n\n1. Push the repository to a node server using a service like [Heroku](https://heroku.com).\n\n2. Install the dependencies:\n\n```bash\nnpm i\n```\n\n3. Build the app:\n\n```bash\nnpm run build\n```\n\n7. Start the app:\n\n```bash\nnpm start\n```\n\nYou can also do the same to deploy locally.\n\n## 📐 Design\n\n- [👚 Models](./docs/models.md)\n- [✨ Features](./docs/features.md)\n- [📝 ToDos](./docs/todos.md)\n\n## 🚀 Development\n\nThe initial project was generated using [**Vue CLI**](https://github.com/vuejs/vue-cli) tool.\n\n### 🏭 Environment\n\n- Runtime: [**NodeJS**](https://github.com/nodejs)\n- Package Manager: [**NPM**](https://github.com/npm)\n- Editor: [**Sublime Text**](https://www.sublimetext.com)\n\n### 🌕 Frontend\n\n- ⚛️ Core:\n  - Main: [**VueJS**](https://github.com/vuejs/vue)\n  - Routing: [**Vue Router**](https://github.com/vuejs/vue-router)\n  - State Management: [**Vuex**](https://github.com/vuejs/vuex)\n- 🎨 UI:\n  - Main: [**Bulma**](https://github.com/jgthms/bulma) / [**Buefy**](https://github.com/buefy/buefy)\n  - Theme: [**Bulmaswatch**](https://github.com/jenil/bulmaswatch)\n  - Icons: [**Font Awesome**](https://github.com/FortAwesome/Font-Awesome)\n  - Animations: [**Animate.CSS**](https://github.com/daneden/animate.css)\n- 🔧 Utils:\n  - AJAX: [**Axios**](https://github.com/axios/axios)\n  - HTML Metadata: [**Vue Meta**](https://github.com/nuxt/vue-meta)\n  - Dates Format: [**Moment**](https://github.com/moment/moment/) / [**Vue Moment**](https://github.com/brockpetrie/vue-moment)\n  - Form Validation: [**VeeValidate**](https://github.com/logaretm/vee-validate)\n  - Data Persistence: [**VuexPersist**](https://github.com/championswimmer/vuex-persist)\n  - Array Handling and Common Tasks: [**Lodash**](https://github.com/lodash/lodash)\n\n### 🌑 Backend\n\nThe backend **API** and **Database** (_Using [file system](https://nodejs.org/api/fs.html) for the moment_) are powered by:\n\n- ⚛️ Core:\n  - Main: [**NodeJS**](https://github.com/nodejs/node) / [**ExpressJS**](https://github.com/expressjs/express)\n- 💽 Database:\n  - Main: [**File System**](https://nodejs.org/api/fs.html) _(⚠️ For the moment)_\n- 🔧 Utils:\n  - Array Handling: [**Lodash**](https://github.com/lodash/lodash)\n  - Data Validation: [**Joi**](https://github.com/hapijs/joi)\n  - Authentication: [**JsonWebToken**](https://github.com/auth0/node-jsonwebtoken)\n  - ID Generation: [**UuidJS**](https://github.com/uuidjs/uuid)\n  - Password Hash Generation: [**Bcrypt.JS**](https://github.com/dcodeIO/bcrypt.js)\n  - Error Classification: [**Common Errors**](https://github.com/shutterstock/node-common-errors)\n  - Console Coloration: [**Colors.JS**](https://github.com/Marak/colors.js)\n  - Mock Data Generation: [**Faker.JS**](https://github.com/marak/Faker.js)\n\n## 📄 License\n\nLicensed under [MIT](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimple-works%2Fnotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimple-works%2Fnotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimple-works%2Fnotes/lists"}