Skip to content

Commit

Permalink
Merge pull request #61 from JeevaRamanathan/update_readme_google-signin
Browse files Browse the repository at this point in the history
Update readme for google signin setup and running locally
  • Loading branch information
DhanushNehru authored Oct 26, 2023
2 parents 808168a + f05acad commit 945d324
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,39 @@ You can use Gitpod in the cloud [![Gitpod Ready-to-Code](https://img.shields.io/
- CSS
- JAVASCRIPT

## Deployment
## Getting Started

To deploy the project locally
To run the project locally we need to setup google signin initially and need a local server like Python's HTTP server or Node.js.

> You need to clone the project and Run the **HTML** file.
### Setting Up Google Sign-In

1. **Create a Google Cloud Project:**
- Visit the [Google Cloud Console](https://console.cloud.google.com/).
- Create new or select an existing project.

2. **Configure OAuth Consent Screen:**
- In the Cloud Console, navigate to "APIs & Services" > "OAuth consent screen."
- Configure the OAuth consent screen with the all required details like app name, user support email, etc..

3. **Create OAuth 2.0 Client ID:**
- In the Cloud Console, go to "APIs & Services" > "Credentials."
- Click "Create Credentials" > "OAuth client ID."
- Choose the application type as Web application and add authorized JavaScript origins. ( eg. http://localhost and http://localhost:3000)
- Note the generated "Client ID."

4. **Set `data-client_id` in HTML from a JSON file:**
- In config.json file replace the client_id with the copied value

### Running the Project

To run the project locally, you need a local server. Before that, make sure you have either Python or Node.js installed.

- **Python:** Run the project with Python's HTTP server using: `python -m http.server 3000`.
- **Node.js:** Start the project with `http-server` using: `npx http-server -p 3000`.

Ensure that the port number mentioned here matches the authorized JavaScript origins. If you have any doubts, refer to the [screenshots](https://github.com/DhanushNehru/board/pull/57) in the comments for additional assistance.

Clone the project & start contributing

Hey, I am Dhanush N,the maintainer of this opensource repository. You can connect with me and support or follow my work via [Twitter](https://twitter.com/Dhanush_Nehru) / [Instagram](https://www.instagram.com/dhanush_nehru/) / [Youtube](https://www.youtube.com/@dhanushnehru?sub_confirmation=1) / [Github](https://github.com/DhanushNehru)

Expand Down

0 comments on commit 945d324

Please sign in to comment.