Skip to content
This repository has been archived by the owner on Apr 21, 2024. It is now read-only.

AccessibilityMentor helps newcomers as well as more experienced accessibility advocates become better in their field.

License

Notifications You must be signed in to change notification settings

YurisCodingClub/accessibility-mentor

Repository files navigation

AccessibilityMentor

Mainly, AccessibilityMentor helps newcomers as well as more experienced accessibility advocates become better in their field. But actually it is much more. By contributing to the Open Source project, you will gain hands-on experience working in an agile team, improve your skills and be part of an awesome community.

Contributing

To contribute to the project, please read the contribution guideline carefully.

‼️ To get more women and especially people with disabilities into tech, I always assign tickets to them first.

CodeNewbies

If you are a complete beginner in open source / GitHub, don't worry. Look at the following description on how to set up the project locally.

If you are a complete beginner in coding or open source, don't worry. Let's start with the following: Look up what semantic HTML means. Think about what a navigation actually is (a list of links). Use the corresponding semantic HTML for it. You can find everything needed to fulfill this issue by looking the terms up in w3schools or MDN. If these sites are new to you, don't worry. You will get used to them over time. Happy coding 🙂

Tech Stack

AccessibilityMentor is build using the following technologies:

  • Next.js - a framework for building server-rendered React applications

Quickstart

Currently only local development is possible.

This environment is fully on your computer and requires each dependency to be installed and set up, but it gives you the most flexibility for customisation.

Prerequisites

Before contributing or adding a new feature, please make sure you have already installed the following tools:

Commands

  1. Create a fork of the project to get your own copy
  2. git clone https://github.com/YurisCodingClub/accessibility-mentor.git - to get the code locally
  3. cd accessibility-mentor - to navigate into the project
  4. npm install - to install all the dependencies
  5. code . - to open Visual Studio Code
  6. npm run dev - to get the project running
  7. npm run storybook - to open storybook in localhost:6006

Support

Don't forget to leave a star ⭐️

Top Contributors

My Pledge

I take participation in the community as a harassment-free experience for everyone and I pledge to act in ways to contribute to an open, welcoming, diverse and inclusive community.

If you have experienced or been made aware of unacceptable behaviour, please remember that you can report this. Read the Code of Conduct for more details.