Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme for google signin setup and running locally #61

Merged
merged 4 commits into from
Oct 26, 2023
Merged

Update readme for google signin setup and running locally #61

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b3bb79
update readme for enabling and setting up google signin
JeevaRamanathan Oct 26, 2023
b39aecd
heading fix
JeevaRamanathan Oct 26, 2023
c466013
word fix
JeevaRamanathan Oct 26, 2023
f05acad
Update README.md
JeevaRamanathan Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions README.md
View file
Open in desktop
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