Hacktoberfest contributions is aimed at helping organisations track any updates in the GitHub repositories participating in Hacktoberfest with respect to commits made, PRs raised and the contributors.
The web-app is planned to be developed in MERN stack (using Typescript).
- The GitHub organisation is entered which is used by the API to check for Hacktoberfest projects and and get all the required data. → or can just put in the repo link
- The data is provided to the user to analyse and make the necessary decisions with respect to their projects.
- A leaderboard for all the contributors in the organization and particular repositorites.
The current plan for the project is defined through the information architecture - it represents the pages required to build the web-app and how the data is represented on a selected page.
This is a Next.js project bootstrapped with create-next-app.
First, run the development server:
npm run dev
# or
yarn devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.
The design system and the low-fidelity prototype designed for the project can be found in the Figma project.
The backend setup is currently under progress, the issues will be listed once the core setup is complete and the project will be open for contributions.
We follow a systematic Git Workflow -
- Create a fork of this repo.
- Clone your fork of your repo on your pc.
- Add Upstream to your clone
- Every change that you do, it has to be on a branch. Commits on master would directly be closed.
- Make sure that before you create a new branch for new changes, syncing with upstream is necessary.
☝ Make sure you have read the Contributions before you start contributing such that you make remarkable and easily acceptable PRs.
