Skip to content

MubarakSULAYMAN/fidia

Repository files navigation

Fidia

The number one collection of creative works ℹ️.

fidia is built with Nuxt 2, bootstrap-vue and lots love ❤️ 💖, and deployed on netlify.

Because of our believe in being progressive, we believe ths is just a work in progress 🚧. But, feel free to explore 🪐 Fidia, thank you friend.


Explore the docs »

View Demo · Report Bug · Request Feature

Table of contents

(Back to top)

Project structure

The following is a description of the folders in this project, and how they are used. Our Application Stack is Bootstrap-vue (HTML5 with WAI-ARIA), CSS3 and VueJS (Javascript).

Application Source HTML, CSS & Javascript Files:

  • assets: Application assets like font, images and styles

    • data: Application data
    • images: Application images
    • styles: Application styles
  • components: Application reusable components files

  • layout: Application wrapper templates

  • pages: Application pages

    • index.vue: Application entry wrapper
  • plugins: Application utility folder

    • globalComponents: Application global reusuable components

    • mixins: Application global reusuable functions

    • main.js: Main vue application entry file

  • store: Application state management folder (for vuex)

    • modules: Application submodules for state management

Development Content - used to automate development & testing:

  • .env: Application environment variables

  • eslintrc.js: Eslint configuration for the app which includes airbnb linting / style guide settings

  • .gitignore: Application ignored files for commits

  • package.json: Package file for Node that gets used during yarn install

  • README.md: App information and guide

Third Party Content ( !.gitignored ):

  • node_modules: Third Party Libraries installed via package.json during yarn install

(Back to top)

Getting Started

Prerequisites

The things you will need in order to use the app and how to install them

  • Before you begin, ensure you have the latest node installed on your computer - Node.js 14.16.1 was used for this

Check with:

# ensure Node.js is >= 14.16.1
vue --version
  • Also ensure you have the latest vue cli installed - Vue CLI 3.O was used for this

Check with:

# ensure Vue CLI is >= 3.0
vue --version

(Back to top)

Project Setup

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

For detailed explanation on how things work, check out the documentation.

(Back to top)

Built with

  • Vue 2 - The progressive javasript framework used

  • External libraries used in this project includes:

    • Bootstrap - The world's most popular front-end open source toolkit for designing and customizing responsive mobile-first sites.
  • Bootstrap Vue - The tool to hemp optimize the use of Vue.js and bootstrap.

(Back to top)

Authors

See also the list of contributors who participated in this project.

(Back to top)

License

This project is licensed under the MIT License.

(Back to top)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

(Back to top)

Acknowledgments

(Back to top)