README.md

Amb-Notes

Public Notes Sharing Web Application.

🌐 View Live Demo

📖 Table of contents

• 📜 Introduction
• 🏁 Getting started
• ✈️ Deployment
• 📐 Design
• 🚀 Development
  • 🏭 Environment
  • 🌕 Frontend
  • 🌑 Backend

📜 Introduction

This is a simple Web application that allows users to post public notes that others can see on the home page.
It is mainly built with VueJS and ExpressJS. It implements many common features using many libraries.
This project can be used for learning purposes or as a starter template for building similar applications.

🏁 Getting started

1. Clone the repository:

cd somewhere
git clone https://github.com/Ambratolm/amb-notes.git
cd amb-notes

2. Install the dependencies:

npm i

3. Install Nodemon globally:

npm i -g nodemon

4. Run app server:

npm run serve

4. Run api server:

npm run api

✈️ Deployment

To deploy the project in a node environment:

1. Push the repository to a node server using a service like Heroku.

2. Install the dependencies:

npm i

3. Build the app:

npm run build

7. Start the app:

npm start

You can also do the same to deploy locally.

📐 Design

• 👚 Models
• ✨ Features
• 📝 ToDos

🚀 Development

The initial project was generated using Vue CLI tool.

🏭 Environment

• Runtime: NodeJS
• Package Manager: NPM
• Editor: Sublime Text

🌕 Frontend

• ⚛️ Core:
  • Main: VueJS
  • Routing: Vue Router
  • State Management: Vuex
• 🎨 UI:
  • Main: Bulma / Buefy
  • Theme: Bulmaswatch
  • Icons: Font Awesome
  • Animations: Animate.CSS
• 🔧 Utils:
  • AJAX: Axios
  • HTML Metadata: Vue Meta
  • Dates Format: Moment / Vue Moment
  • Form Validation: VeeValidate
  • Data Persistence: VuexPersist
  • Array Handling and Common Tasks: Lodash

🌑 Backend

The backend API and Database (Using file system for the moment) are powered by:

• ⚛️ Core:
  • Main: NodeJS / ExpressJS
• 💽 Database:
  • Main: File System (⚠️ For the moment)
• 🔧 Utils:
  • Array Handling: Lodash
  • Data Validation: Joi
  • Authentication: JsonWebToken
  • ID Generation: UuidJS
  • Password Hash Generation: Bcrypt.JS
  • Error Classification: Common Errors
  • Console Coloration: Colors.JS
  • Mock Data Generation: Faker.JS

📄 License

Licensed under MIT.