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.

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

CREATE A SEARCH INPUT FIELD THAT ENABLES A PLAYER TO SEARCH FOR AND INVITE A COLLEAGUE TO JOIN AS PLAYER 2. #415

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file removed .DS_Store
Binary file not shown.
7 changes: 3 additions & 4 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name: Chessboard Deployment Pipeline

on:
# Triggers the workflow on push or pull request events but only for the dev branch
# Triggers the workflow on push or pull request events but only for the main branch
push:
branches: [dev]
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand All @@ -23,8 +23,7 @@ jobs:
username: ${{ secrets.USERNAME }}
script: |
cd /var/www/zc_plugin_chessboard/
git stash
git pull origin dev
git pull origin main
cd server
yarn install
yarn build
Expand Down
114 changes: 48 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,100 +5,82 @@
Zuri chesss plugin is a web based recreational and competitive board game played between two players with an option for AI, that can easily be installed and used as part of the Zuri chat main application.

## Design:

Figma link to the design implemented:
<br>
coming soon!
coming soon!

## Hosted URL:

https://chess.zuri.chat/

## Tech Stack:

- React js
- Nodejs
- Ajax
- WebSockets
- React js
- Nodejs
- Ajax
- WebSockets

# Project Setup & Contribution Guide:

- Fork this REPO
- Clone the repo from your account

```
git clone https://github.com/<username>/zc_plugin_chessboard.git
```
- Fork this REPO
- Clone the repo from your account
```
git clone https://github.com/<username>/zc_plugin_chessboard.git
```

#

## For BACKEND

- switch to the backend directory and install all dependencies

```
cd server
npm install or yarn install
```
- switch to the backend directory and install all dependencies
```
cd server
npm install or yarn install
```

## For FRONTEND

- switch to the frontend directory and install all dependencies

```
cd client
npm install or yarn install
```

- switch to the frontend directory and install all dependencies
```
cd client
npm install or yarn install
```
#

- Add the main repo remote to your project upstream

```
git remote add upstream https://github.com/zurichat/zc_plugin_chessboard.git
```

- Pull from upstream
- Add the main repo remote to your project upstream
```
git remote add upstream https://github.com/zurichat/zc_plugin_chessboard.git
```

```
git pull upstream dev
```
- Pull from upstream
```
git pull upstream dev
```

- Switch to a new branch with your {feature-name}
- Switch to a new branch with your {feature-name}
```
git checkout -b <feature-name>
```

```
git checkout -b <feature-name>
```

- Add your work/code

- When done making your changes, run
- Add your work/code

- When done making your changes, run
```
git add .
git commit -m 'your commit message'
git push origin <feature-name>
```

- Create a Pull Request to `dev` branch
- Create a Pull Request to `` dev `` branch

<br>

# For Local Testing:

- Run backend server

```
cd server
npm run dev or yarn run dev
```

- Open http://127.0.0.1:5050/ping
- Open another terminal in vscode and run

```
cd client
npm start or yarn start
```

- Open http://127.0.0.1:3000/
# For Local Testing:
- Run backend server
```
cd server
npm run dev or yarn run dev
```
- Open http://127.0.0.1:5050/ping
- Open another terminal in vscode and run
```
cd client
npm start or yarn start
```
- Open http://127.0.0.1:3000/
Loading