{"id":49182543,"url":"https://github.com/simple-works/notes-old","last_synced_at":"2026-04-23T02:03:46.886Z","repository":{"id":39193971,"uuid":"247777687","full_name":"simple-works/notes-old","owner":"simple-works","description":"💥 📝 Public-notes-sharing Web application (Mock Backend)","archived":false,"fork":false,"pushed_at":"2023-01-05T10:20:28.000Z","size":4387,"stargazers_count":5,"open_issues_count":26,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-07-17T02:47:31.305Z","etag":null,"topics":["buefy","bulma","fake-api","fake-api-json-server","json-server","mock-api","notes-app","social-network","template-project","vue","vue-app","vue-app-demo","vue-application","vue-application-template","vue-bulma","vue-demo","vue-project","vue-template","vue-template-project","vuejs"],"latest_commit_sha":null,"homepage":"https://amb-notes-old.herokuapp.com","language":"Vue","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/simple-works.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}},"created_at":"2020-03-16T17:30:17.000Z","updated_at":"2024-03-07T17:24:22.000Z","dependencies_parsed_at":"2023-02-04T00:46:30.436Z","dependency_job_id":null,"html_url":"https://github.com/simple-works/notes-old","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/simple-works/notes-old","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes-old","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes-old/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes-old/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes-old/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simple-works","download_url":"https://codeload.github.com/simple-works/notes-old/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simple-works%2Fnotes-old/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":["buefy","bulma","fake-api","fake-api-json-server","json-server","mock-api","notes-app","social-network","template-project","vue","vue-app","vue-app-demo","vue-application","vue-application-template","vue-bulma","vue-demo","vue-project","vue-template","vue-template-project","vuejs"],"created_at":"2026-04-23T02:03:37.002Z","updated_at":"2026-04-23T02:03:46.867Z","avatar_url":"https://github.com/simple-works.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Check out [:notebook: Amb-Notes-NEW](https://github.com/Ambratolm/amb-notes) for a better code redesign and real backend !\n\n# :notebook: Amb-Notes-Old\n\n\u003e Public notes sharing web application. [**View Demo**](https://amb-notes-old.herokuapp.com)\n\n![amb-notes-screenshot](/screenshot.gif?raw=true \"Screenshot of the app\")\n\n## Table of contents\n\n\u003c!-- toc --\u003e\n\n- [Introduction](#introduction)\n- [Getting started](#getting-started)\n- [Deployment](#deployment)\n- [Technologies](#technologies)\n  - [Frontend](#frontend)\n  - [Backend](#backend)\n- [Features](#features)\n  - [Authentication](#authentication)\n  - [Notes Feed](#notes-feed)\n  - [User Profile](#user-profile)\n  - [Administration](#administration)\n- [Data Models](#data-models)\n  - [User](#user)\n  - [Note](#note)\n\n\u003c!-- tocstop --\u003e\n\n## Introduction\n\n1. **What is this ?**\n\nThis is a simple VueJS app where users can register and login to post public notes that are shown in the homepage feed.\n\n2. **What is it for ?**\n\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 repo and Install the dependencies:\n\n```bash\ncd [somewhere]\ngit clone https://github.com/Ambratolm/amb-notes.git\ncd amb-notes\nnpm i\n```\n\n2. Install **JSON Server Auth** globally:\n\n```bash\nnpm i -g json-server-auth\n```\n\n3. In **package.json** file, Go to `scripts`. In `serve` and `serve-db` scripts, Change the `host` and `port` to your likings. You can replace `app.ambratolm.com` and `db.ambratolm.com` with `localhost` or any localhost aliases you have defined in your system.\n\n```json\n  \"scripts\": {\n    \"serve\": \"vue-cli-service serve --open --host=app.ambratolm.com --port=2020\",\n    \"serve-db\": \"json-server-auth db/db.js --routes=db/routes.json --watch --delay=2000 --host=db.ambratolm.com --port=2021\"\n  }\n```\n\n4. Run the app server:\n\n```bash\nnpm run serve\n```\n\n5. Run the _fake_ database server:\n\n```bash\nnpm run serve-db\n```\n\n## Deployment\n\nTo deploy the project in a node environment:\n\n1. Push the repo 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\nIf you want to start the app and watch for changes in **server.js** file, install **nodemon** globally:\n\n```bash\nnpm i -g nodemon\n```\n\nthen start the app with monitoring mode:\n\n```bash\nnpm run start-m\n```\n\n## Technologies\n\nThe initial project was generated using [**Vue CLI**](https://github.com/vuejs/vue-cli) tool.\n\n### Frontend\n\nThis app is mainly powered by:\n\n- [**VueJS**](https://github.com/vuejs/vue) (JS framework) with its integrated packages: - [**Vue Router**](https://github.com/vuejs/vue-router) (For routing) - [**Vuex**](https://github.com/vuejs/vuex) (For centralized state management)\n\nThe app **GUI** is powered by:\n\n- [**Bulma**](https://github.com/jgthms/bulma) (CSS framework)\n- [**Buefy**](https://github.com/buefy/buefy) (Vue UI Bulma components)\n- [**Bulmaswatch**](https://github.com/jenil/bulmaswatch) (Bulma themes)\n- [**FontAwesome**](https://github.com/FortAwesome/Font-Awesome) (Icons used through Buefy)\n- [**AnimateCSS**](https://github.com/daneden/animate.css) (CSS animations)\n\nThe app is using these **utilities**:\n\n- [**Axios**](https://github.com/axios/axios) (For AJAX calls)\n- [**Vue Meta**](https://github.com/nuxt/vue-meta) (For adding HTML metadata)\n- [**Moment**](https://github.com/moment/moment/)/[**Vue Moment**](https://github.com/brockpetrie/vue-moment) (For formatting dates)\n- [**VeeValidate**](https://github.com/logaretm/vee-validate) (For form validation)\n- [**VuexPersist**](https://github.com/championswimmer/vuex-persist) (For data persistence)\n- [**Lodash**](https://github.com/lodash/lodash) (For common tasks, especially array related)\n\n### Backend\n\n_No real backend used for the moment._\n\nThe backend **API** and **Data** are **similated** using:\n\n- [**JSON Server**](https://github.com/typicode/json-server)/[**JSON Server Auth**](https://github.com/jeremyben/json-server-auth) (JSON-based API backend simulator)\n- [**Faker**](https://github.com/marak/Faker.js) (Fake data generator)\n\nFor deploying the [**demo**](https://amb-notes.herokuapp.com), a node server was created using:\n\n- [**Express**](https://github.com/expressjs/express) (Node framework) with the [**serve-static**](https://github.com/expressjs/serve-static) module (For serving app files)\n\n## Features\n\n### Authentication\n\n- [x] As visitor you can register\n- [x] As visitor you can login and logout\n- [x] As user you can edit your account data\n\n### Notes Feed\n\n- [x] As visitor you can view all notes\n- [x] As user you can post, edit and remove a note\n\n### User Profile\n\n- [x] As user you have a profile page that shows all of your notes\n- [x] As user you can view other users profile pages\n- [x] As user you can edit your profile page\n\n## Data Models\n\n### User\n\n| Name            | Type | Rules                                        |\n| :-------------- | :--- | :------------------------------------------- |\n| **id**          | text | **[ primary-key ]**                          |\n| **email**       | text | **[ required ][ unique ] [ format: email ]** |\n| **password**    | text | **[ required ][ length: 8-80 ]**             |\n| **name**        | text | **[ required ][ length: 3-30 ]**             |\n| **description** | text | **[ length: 0-100 ]**                        |\n| **avatar**      | text | **[ format: url ]**                          |\n| **role**        | text | **[ values: \"\", \"admin\" ]**                  |\n\n### Note\n\n| Name        | Type | Rules                             |\n| :---------- | :--- | :-------------------------------- |\n| **id**      | text | **[ primary-key ]**               |\n| **userId**  | text | **[ foreign-key: user ]**         |\n| **date**    | text | **[ format: datetime ]**          |\n| **title**   | text | **[required][ length: 3-30 ]**    |\n| **content** | text | **[required][ length: 10-1000 ]** |\n\n##\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimple-works%2Fnotes-old","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimple-works%2Fnotes-old","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimple-works%2Fnotes-old/lists"}