https://github.com/codelikeagirl29/github-api
A React site using Github's API for a dynamic page with your Profile and Project links.
https://github.com/codelikeagirl29/github-api
github-api-v3 react styled-components
Last synced: about 1 month ago
JSON representation
A React site using Github's API for a dynamic page with your Profile and Project links.
- Host: GitHub
- URL: https://github.com/codelikeagirl29/github-api
- Owner: CodeLikeAGirl29
- Created: 2022-10-19T06:25:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T08:42:31.000Z (over 3 years ago)
- Last Synced: 2025-03-26T21:13:52.490Z (about 1 year ago)
- Topics: github-api-v3, react, styled-components
- Language: JavaScript
- Homepage: https://mygithubapi.vercel.app/
- Size: 312 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Github Profile using [Github API](https://docs.github.com/en/rest)
Created a dynamic PWA using React, styled-components, and the Github API.
---
## Getting Started
Instructions for getting this to display your Github stats.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/codelikeagirl29/github-api.git
```
2. Install NPM packages
```sh
npm install
```
3. Enter your username in `/src/containers/Profile.js`
```js
const profile = await fetch(
'https://api.github.com/users/codelikeagirl29'
);
```
---
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
### Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
### Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
### Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
### Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
### `npm run build` fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify