A project dedicated to championing open-source education in Nigeria 🇳🇬. We achieve this by sharing past examination questions from higher institutions, making them accessible and available to all students. Our goal is to help students prepare effectively for examinations.
- Git
- Node: Any version in the 20.x range, starting with v20.0.0 or higher.
- A fork of the repository (for any contributions).
- A clone of the examshare repository on your local machine using
git clone https://github.com/udohjeremiah/examshare.git
cd examshareto navigate to the project's root directory.npm installto install the website's npm dependencies.
npm run devto start the development server (powered by Next.js)- Open
http://localhost:3000in your favorite browser to access the site.
A solid understanding of React.js, Next.js 13 (App Router), and Tailwind CSS is required to contribute effectively, whether you are providing new code or improving existing code. You can also make valuable contributions by suggesting new designs, layouts, or color schemes for the website; such contributions are welcomed and highly appreciated.
Contributing code or creating new design systems is not the sole way to help this project grow. You can also submit your previous examination questions using the dedicated section on the website. This also provides significant assistance.
While there may not be a dedicated "Contributing Guidelines" section as commonly seen in GitHub projects, it is important to emphasize the need for respect towards everyone, regardless of their diversity. Lastly, being a "kind and considerate person" is encouraged.
git checkout mainfrom any folder in your localexamsharerepository.git pull origin mainto ensure you have the latest code from themainbranch.git checkout -b the-name-of-my-branch(replacethe-name-of-my-branchwith a suitable name) to create a new branch.
- Follow the "Running locally" instructions.
- Save the files and check them in the browser.
- Changes to React components in the
srcdirectory will hot-reload.
- Run
npm run format. This command uses Prettier to validate code formatting, ensuring it adheres to Prettier's style. To correct any code format issues, usenpm run format:fix. - Run
npm run lint. This command runs ESLint to catch any linting errors. Be sure to fix any errors and warnings that may appear. - If possible, test any visual changes in the latest versions of common browsers, both on desktop and mobile.
git add -A && git commit -m "My message"(replacingMy messagewith a commit message, such asFix navigation on mobile screen) to stage and commit your changesgit push my-fork-name the-name-of-my-branch(substitutemy-fork-namewith the actual name of the fork of the examshare repository you have in your GitHub account andthe-name-of-my-branchwith the actual name of the branch you created in the previous step when creating a branch).- Go to the examshare repo (i.e. the one you forked) and you should see recently pushed branches.
- Follow GitHub's instructions to open a pull request.
- A Next.js build (
next build) is triggered after your changes are pushed to GitHub.
This project is licensed under the MIT License, as detailed in the LICENSE.md file.