Contributing to GitStory

Code Structure

Frameworks/Libraries :

GitStory is built with Next.js & React with TypeScript, these libraries are also used :

Styled Components : For CSS/UI Components.
Redux : For State management.
Framer Motion : For transitions and motion.
GitStoryKit : For Interactions with the GitHub API.
Next Auth : For Authentication.

Directories/Structures :

public : Contains images & public assets
services : Data gathering functions
pages : Next.js pages
components: React components

Commands

Install packages

$ npm i

Run in development mode

$ npm run dev

Build & start the app

$ npm run build 
$ npm run start

Submitting Contributions

This project follows GitHub's standard forking model. Please fork the project to submit pull requests.

Submitting a feature/bugfix to the project

Create Issue with tag enhancement or bug
Fork the repository
Clone your fork locally
Create a new branch and make your commits
Push your commits to your forked repo
Make a Pull request
Code will be added after review