<< Kata Golla >>

Bored? Check out my KG game(for kindergarten kids you say? probably!).

You're "welcome"!

---

View Demo · Report Bug · Request Feature

Built With

Did you know it's my first time using the first four things mentioned below? It was fun learning them!

• Node.js
• Express.js
• Socket.io
• Mongoose
• React.js
• Material UI

Getting Started

I'll be explaining how you can start it up locally for now.

Prerequisites

• node version 16.x
• mongodb or mongo atlas version ^4.x

Docker Installation

In case you want to use mongo atlas, skip the mongo section below and update MONGO_URL in project_root/server/.env instead.

git clone https://github.com/m-s-abeer/kata-golla.git
cd kata-golla

cp client/env.example client/.env
cp server/env.example client/.env

mongo
use kata-golla
exit

docker build -t kata-golla .
docker run -d --name="kata-golla-3001" -p 3001:3001 kata-golla

• Ready to go! Checkout http://localhost:3001/ and start playing! (you may change port 3001 if required)
• The react client is served as a static build and it's routed from node server.
• To stop the docker container run docker stop kata-golla-3001

(back to top)

### Local Installation

Here we'll use stand-alone React and Node server. Just for the !fun of it! ⚆ _ ⚆

1. Clone the repo locally:-

   HTTPS: git clone https://github.com/m-s-abeer/kata-golla.git

2. Create a local mongo database from mongo CLI

   mongo
   use kata-golla
   exit

   You can use a mongo atlas cluster as well, in that case update MONGO_URL in project_root/server/.env later on

3. Get into project root cd kata-golla

4. Install client-side NPM packages and start front-end

   relative to project root

   cd client
   npm install
   cp env.example ./.env
   npm start

5. Install server-side NPM packages and start back-end

   relative to project root

   cd server
   npm install
   cp env.example ./.env
   npm start

• Ready to go! Checkout http://localhost:3000/ and start playing!

(back to top)

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Mahmud Sajjad Abeer

• linkedin: msabeer
• [email protected]

(back to top)