📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 🔑 Key features
- 🛢 Live Demo
- 👥 Authors
- 🤝 Contributing
- ⭐️ Show your support -- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
📖 [Conference-website]
[Conference-website] A conference website concept based on the orginal theme design by Cindy Shin and customized for the Sapien-Ai conference according to the requirements of the Mircoverse capstone project.
🛠 Built With
Tech Stack
Key Features
- [Responsive Website(Mobile and Web)]
- [Home Page]
- [About Page]
🚀 Live Demo
💻 Getting Started
Setting up the "Conference-website" project:
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
-A Git hub account
-Node JS
-Visual Studio Code or any other code editor of your preference
-web browser
Setup
Clone this repository to your desired folder:
cd my-folder
git clone git@github.com:RileyManda/Conference-website.git
Advantages of Linters:
1: improves readability-it will be easy to read and make adjustment if required easily.
2:removes silly errors before execution and code review.
3:Makes code look like written by a single person.
4:Spreads awareness and ownership over code quality
5:Having more secure and performant code.
Install Linters
You can find linters for most of the programming languages, e.g. Rubocop for Ruby or ESLint for JavaScript.
Also, there are many ways you can integrate a linter in your workflow:
-text editor plugin
-GitHub Actions
-GitHub apps
Set up Linters
Note: The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:
.gitignore
node_modules/
Web Hint
This is a customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors.
NOTE: If you are using Windows, make sure you initialize npm to create package.json
file.
npm init -y
- Run
how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
npm install --save-dev hint@7.x
- Copy .hintrc to the root directory of your project.
- Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.
- If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it.
- Run
npx hint .
- Fix validation errors.
Stylelint
A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
- Run
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x not sure how to use npm? Read this.
-
Copy .stylelintrc.json to the root directory of your project.
-
Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.
If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "*/.{css,scss}" on the root of your directory of your project.
-
Fix linter errors.
-
IMPORTANT NOTE: feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!
👥 Authors
👤 Riley Manda
- GitHub: @RileyManda
- Twitter: @rilecodez
- LinkedIn: rileymanda
🤝 Attribution
Summit Images from - Ethzurich: @Ethzurich
🔭 Future Features
-
[Implement Javascript DOM] Javascript will be added to the project to support click events.
-
[Develop the Desktop Version] This feature comprise of the desktop version of the website.
-
[RWD] The site will be updated(Desktop Version) to utilize media queries for responsivenes to create a Desktop version.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
If you like this project, kindly leave a comment below , ⭐️ Star the project and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!
🙏 Acknowledgments
I'm grateful to microverse for giving me this opportunity to grow into my full potential through continuous learning and practical challenges.
❓ FAQ
-
[Question_1] Do I have to use the vs code specifically?
- [Answer_1] You can use any code editor of your chose.
-
[Question_2] Where can I download node JS for installation?
- [Answer_2] Node Js can be downloaded here- https://nodejs.org/en/download/
📝 License
This project is MIT licensed.