Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vlaek/githubchecker
https://github.com/vlaek/githubchecker
axios css-modules github-api graphql material-ui react redux-toolkit scss typescript vite
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/vlaek/githubchecker
- Owner: Vlaek
- Created: 2024-08-08T17:31:35.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-11T04:51:50.000Z (3 months ago)
- Last Synced: 2024-10-15T19:25:38.052Z (about 1 month ago)
- Topics: axios, css-modules, github-api, graphql, material-ui, react, redux-toolkit, scss, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 72.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Installation
1. **Cloning a repository**:
```bash
git clone https://github.com/Vlaek/GitHubChecker.git
cd GitHubChecker
```
2. **Installing dependencies**:
```bash
npm install
```
```bash
yarn
```
3. **Creation .env file to the root of the project**:
```bash
touch .env
```
4. **Write your github api token in the .env file**:
```bash
VITE_GITHUB_TOKEN=
```
5. **Launching the application**:
```bash
npm start
```
```bash
yarn dev
```
#
```plaintext
src/
│
├── components/
│ ├── index.ts
│ └── Component/
│ ├── Component.tsx
│ └── Component.module.scss
│
├── containers/
│ ├── index.ts
│ └── Container/
│ ├── Container.tsx
│ └── Container.module.scss
│
├── graphql/
│ ├── client.ts
│ └── queries.ts
│
├── shared/
│ ├── styles/
│ └── types/
│
├── store/
│ ├── store.ts
│ └── slices/
│ └── Slice.ts
│
└── main.tsx
```
# Technologies
- React
- TypeScript
- SCSS, CSS Modules
- MUI
- Axios
- Redux Toolkit
- graphql
- Vite
# Illustrations
