CSC/ECE 517 Spring 2024 -

From Expertiza_Wiki
Revision as of 02:45, 9 April 2024 by Vasanap (talk | contribs) (Created page with "# GitHub Data Viewer: React Frontend This repository contains the frontend implementation for the GitHub Data Viewer project. ## Project Overview The project aims to build a React-based user interface that interacts with backend APIs to display GitHub repository and contributor data. ## Getting Started 1. Clone this repository. 2. Navigate to the project directory. 3. Install dependencies: `npm install` 4. Start the development server: `npm start` ## Project Struc...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
  1. GitHub Data Viewer: React Frontend

This repository contains the frontend implementation for the GitHub Data Viewer project.

    1. Project Overview

The project aims to build a React-based user interface that interacts with backend APIs to display GitHub repository and contributor data.

    1. Getting Started

1. Clone this repository. 2. Navigate to the project directory. 3. Install dependencies: `npm install` 4. Start the development server: `npm start`

    1. Project Structure

- `/src`: Contains all the source code for the React application.

 - `/components`: Reusable UI components.
 - `/pages`: React components for different views (e.g., Home, Repository Detail).
 - `/services`: Axios service for API requests.
 - `/utils`: Helper functions and utilities.

- `/public`: Static assets and HTML template.

    1. Available Scripts

- `npm start`: Starts the development server. - `npm test`: Launches the test runner.

    1. Technologies Used

- React - Axios - React Router - Bootstrap (or Material-UI)

    1. Contributors

- Atharva Pansare - Sumedh Limburkar - Viraj Sanap