-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Denys Dinkevych
authored
Nov 17, 2024
1 parent
158fc59
commit 2dd9761
Showing
2 changed files
with
26 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters