Aishatu-Gobir-Inaugural-Lecture

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Webpack Boiler Plate]

Webpack Boiler Plate is a capstone project to fulfil the requirement for the completion of Module One of Full Stack Web Developement Program at Microverse Inc. This project features the main lecture as well as keynote speakers for the 219th Inaugural Lecture at the University of Ilorin, Ilorin, Nigeria.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JAVASCRIPT

Key Features

• [Responsive design]
• [Home and About Pages]
• [Keynote Speakers]

(back to top)

🚀 Live Demo

• Webpack Boiler Plate

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• The current version of node
• To have Git installed on your local machine
• Node Package manager (npm)
• An editor such as Visual Studio Code

Setup

Clone this repository to your desired folder:

• Create your classic access token from github.com
• run "git clone https://{access_token}@github.com/username/{repo_name}.git"
• Update your git identity by running "git config --global user.email "your_email@gmail.com""
• Update your name on git by running "git config --global user.name "your_name"

Install

Install this project with:

• In the first commit of your feature branch create a .github/workflows folder and add a copy of [.github/workflows/linters.yml](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.github/workflows/linters.yml) to that folder.
• create a .gitignore file and add 'node_modules' to it
• run 'npm init -y'
• run 'npm install --save-dev hint@7.x'
• Copy [.hintrc](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.hintrc) to the root directory of your project.
• run 'npx hint .'
• Fix validation errors.
• run 'npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x'
• Copy [.stylelintrc.json](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.stylelintrc.json) to the root directory of your project.
• Run 'npx stylelint "**/*.{css,scss}"'
• fix linter errors
• run 'npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x'
• Copy [.eslintrc.json](https://github.com/microverseinc/linters-config/tree/master/html-css-js)
• Run npx eslint . on the root of your directory of your project
• Fix linter errors

Usage

To run the project, execute the following command:

  use git bash to open in Vs code
  run 'npm run build'

Run tests

To run tests, run the following command:

Run "npx hint ."
Run "npx stylelint "**/*.{css,scss} --fix " to fix linters
Run "npx eslint . --fix to fix linters"

Deployment

You can deploy this project using:

• github pages

(back to top)

👥 Authors

👤 Author1

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [contact form page]
• [Seat selection and Seat-Booking feature]
• [A page for Financial Donations towards the Inaugural Lecture ]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, kindly drop a star for me.

(back to top)

🙏 Acknowledgments

I would like to use this medium to appreciate Microverse team for putting up the original design idea.

(back to top)

📝 License

This project is MIT licensed.

(back to top)