moppdev/KnowYourConstitution1996

An open-source website that allows users to access and understand South Africa's 1996 Constitution in an easy, user-friendly and intuitive manner. # KnowYourConstitution1996 (KYC1996) ## Table of Contents - Description and Background - Tech Stack - Getting Started - Contributing - License ## Description and Background **KnowYourConstitution1996** is an open-source website that offers simple, intuitive access to the contents of South Africa's current Constitution. The aim of this project is to make the Constitution as accessible as possible to the general public. **The inspiration for this** came from my own struggles to look up sections of the Constitution whenever they were mentioned in the news, whether about court cases or controversial Bills like the Expropriation Act. I often had to rely on my hard copy of the Constitution (which not everyone has) or find a government-hosted PDF version (which isn’t always reliable or easy to navigate). I thought it was **quite the schlep** to do, so I wondered, "Isn't there an easier way to do this?". I searched GitHub and found a few Markdown versions of the Constitution, but they didn’t really solve the accessibility issue. So I decided to build this solution. The core of this website is the ZAConstitution1996 API, an open-source API containing all the contents of the Constitution. ## Tech Stack - Vite - React - TypeScript - React Router - Shiki - ESLint - Axios - Tailwind CSS - Font Awesome - npm ## Getting Started First off, clone this repository by entering the following in your terminal of choice: ```bash git clone github.com ``` Navigate to the directory: ```bash cd KnowYourConstitution1996 ``` Install all dependencies and run: ```bash npm install npm run dev ``` Open a tab in your default browser on your local machine at ```localhost``` to see the homepage. ## Contributing Pull requests are welcome. Please check **contribution.md** for more information. ## License This project is licensed under the MIT License.