Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
Denys Dinkevych authored Nov 17, 2024
1 parent 158fc59 commit 2dd9761
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 13 deletions.
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
# Your Project Name
# GitHub Bio Search

Brief description of your project.
Search GitHub users by their bio descriptions. Built with React, TypeScript, and Tailwind CSS.

## Getting Started
## Setup

1. Clone the repository
2. Copy `.env.example` to `.env` and fill in your values
3. Install dependencies:
2. Install dependencies:
```bash
npm install
```
4. Run the development server:

3. Create a `.env.local` file with your GitHub credentials:
```
VITE_GITHUB_TOKEN=your_github_token
VITE_GITHUB_CLIENT_ID=your_client_id
```

4. For development:
```bash
npm start
netlify dev
```

## Deployment
## Environment Variables

### Local Development
- `VITE_GITHUB_TOKEN`: GitHub Personal Access Token
- `VITE_GITHUB_CLIENT_ID`: GitHub OAuth App Client ID

### Netlify Deployment
Set these in Netlify environment variables:
- `GITHUB_CLIENT_ID`: OAuth App Client ID
- `GITHUB_CLIENT_SECRET`: OAuth App Client Secret
- `VITE_GITHUB_CLIENT_ID`: Same as GITHUB_CLIENT_ID

This project is configured for deployment on Netlify.
## License

1. Push your code to GitHub
2. Connect your GitHub repository to Netlify
3. Configure your environment variables in Netlify's dashboard
MIT
1 change: 0 additions & 1 deletion src/env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
interface ImportMetaEnv {
readonly VITE_GITHUB_TOKEN: string
readonly VITE_GITHUB_CLIENT_ID: string
readonly VITE_GITHUB_CLIENT_SECRET: string
}

interface ImportMeta {
Expand Down

0 comments on commit 2dd9761

Please sign in to comment.