https://github.com/amiraliamhh/mh

https://github.com/amiraliamhh/mh

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/amiraliamhh/mh
• Owner: amiraliamhh
• Created: 2022-04-11T12:44:35.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-04-12T07:26:52.000Z (over 2 years ago)
• Last Synced: 2024-10-27T10:56:24.511Z (about 2 months ago)
• Language: Vue
• Size: 288 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This app was tested on node versions `16.13.1` and `14.17.4`. It's preferable to use one of these two if you have them installed, if you don't, it should still be fine.

## Installation

After cloning the project,

using NPM:

`npm i`

using Yarn:

`yarn`

and then to run the project in `dev` mode:

`npm run dev`

or

`yarn dev`

Then navigate to [http://localhost:3000/mh/](http://localhost:3000/mh/).

## Third party libraries used in this project

Other than 3rd party libs that are dependencies of `nuxt.js`, TailwindCSS and @nuxtjs/svg have been added to the project.

### TailwindCSS

**some** of the TailwindCSS pros and cons:

Pros:

1. TailwindCSS offers many utilities that make it easier to develop a responsive app (pre-made screen breakpoints, media query utils, etc).

2. Utility classes make it faster to develop a web app vs. manually writing CSS for every element.

Cons:

1. It makes the HTML hard-to-read and maintain. Sometimes managing all of the class names given to an element becomes an issue.

Given that in my opinion, the main trade-off is between _maintainability_ vs. _fast development_, and this is a test project, I decided to go with fast development.

### @nuxtjs/svg

Only for importing SVGs as inline imports.