{"id":18141362,"url":"https://github.com/prechy123/board-games","last_synced_at":"2025-04-22T13:11:07.408Z","repository":{"id":258694099,"uuid":"867620383","full_name":"prechy123/board-games","owner":"prechy123","description":"[web/server] A user friendly Real-Time Cross-Platform Application to play different board games(such as. Tic-Tac-Toe, Chess, Checkers, Scrabble, Ludo e.t.c) with your friends and family. NextJs, NodeJs, React-Native","archived":false,"fork":false,"pushed_at":"2024-10-23T19:58:49.000Z","size":1335,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T15:23:43.645Z","etag":null,"topics":["clean-code","cloudinary","framer-motion","frontend","nextjs14","nextjs14-typescript","nodejs","socket-io","tailwindcss","vercel"],"latest_commit_sha":null,"homepage":"https://board-games-two.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prechy123.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-04T12:06:44.000Z","updated_at":"2025-01-12T02:38:09.000Z","dependencies_parsed_at":"2024-10-21T17:51:34.367Z","dependency_job_id":null,"html_url":"https://github.com/prechy123/board-games","commit_stats":null,"previous_names":["prechy123/board-games"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prechy123%2Fboard-games","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prechy123%2Fboard-games/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prechy123%2Fboard-games/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prechy123%2Fboard-games/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prechy123","download_url":"https://codeload.github.com/prechy123/board-games/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250246727,"owners_count":21398919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-code","cloudinary","framer-motion","frontend","nextjs14","nextjs14-typescript","nodejs","socket-io","tailwindcss","vercel"],"created_at":"2024-11-01T17:06:30.198Z","updated_at":"2025-04-22T13:11:07.371Z","avatar_url":"https://github.com/prechy123.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Board Games\r\nA user friendly Real-Time Cross-Platform Application to play different board games(including Tic-Tac-Toe, Chess, Checkers, Scrabble, Ludo e.t.c) with your friends and family. NextJs, NodeJs, React-Native \r\n![image](https://github.com/user-attachments/assets/9847c80d-5ed5-4960-a0ed-f1d30551c981)\r\n\r\n## Features\r\n\r\n- **User Profiles:** Create a personalized profile.\r\n- **Real Time:** Get updated values Real-Time without need to refresh page.\r\n- **Board Game:** Play your favourite board games with your friends and family.\r\n\r\n## Getting Started\r\n\r\nTo get a local copy up and running, follow these simple steps.\r\n\r\n## 1. Prerequisites\r\nBefore you proceed, ensure that you have the following prerequisites installed:\r\n\r\n- Node.js and npm: [Download and Install Node.js](https://nodejs.org/)\r\n- MongoDB: [Download and Install MongoDB](https://www.mongodb.com/try/download/community)\r\n- Git: [Download and Install Git](https://git-scm.com/downloads)\r\n\r\n## 2. Project Structure\r\nmern-food-website/  \r\n├── server/  \r\n│   └── ...  \r\n├── client/  \r\n│   └── ...  \r\n├── LICENSE   \r\n└── readme.md  \r\n\r\n\r\n\r\n## 3. Setting up the Backend\r\n\r\n\r\n### Express.js Configuration\r\nEnsure you are using the latest node version \r\n1. Navigate to the `server` directory: `cd server`.\r\n2. Install dependencies: Run `npm install`.\r\n3. Create a `.env` file in the `backend` directory and add the following environment variables:\r\n```\r\nPORT = 5000  \r\nMONGO_URI = your_mongodb_connection_string  \r\nJWT_SECRET = Your_jwt_secret_phrase  \r\nEMAIL_USER= Your mail for nodemailer email address\r\nEMAIL_PASSWORD= Your nodemailer app password (Note: This is not the email password)\r\nBASE_URL= Your frontend route (e.g. http://localhost:3000)\r\nCLOUDINARY_NAME = Your_cloudinary_name\r\nCLOUDINARY_APIKEY = Your_cloudinary_apikey\r\nCLOUDINARY_APISECRET = Your_cloudinary_apisecret\r\nCLOUDINARY_URL = Your_cloudinay_url\r\n```\r\nReplace `your_mongodb_connection_string` with your MongoDB connection string, and `Your_jwt_secret_phrase` with a secret key for JWT authentication.\r\n\r\n4. Configure cloudinary account\r\n\r\n5. Start the Express.js server: Run `npm run dev`.\r\n\r\n## 4. Setting up the Frontend\r\n\r\n1. Navigate to the `client` directory: `cd client`.\r\n2. Install dependencies: Run `npm install`.\r\n3. Create a `.env.local` file in the `client` directory and add the following environment variables:\r\n\r\n```\r\nNEXT_PUBLIC_BACKEND_URL = Your server url (e.g. http://localhost:5000)\r\nNEXT_PUBLIC_JWT_SECRET = Your JWT secret\r\n```\r\n\r\n4. Start the React frontend: Run `npm run dev`.\r\n\r\n## 5. Running the Application\r\n- Access the website at `http://localhost:3000/`.\r\n \r\n\r\n## Contributing\r\nContributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.\r\nIf you'd like to contribute to this project, follow the following steps:-   \r\n\r\n1. Fork the Project\r\n2. clone the repository\r\n3. Create your Feature Branch (git checkout -b feature/AmazingFeature)\r\n4. Commit your Changes (git commit -m 'Add some Amazing Feature')\r\n5. Push to the Branch (git push origin feature/AmazingFeature)\r\n6. Open a Pull Request\r\n\r\n## ScreenShots\r\n### Home Page\r\n![image](https://github.com/user-attachments/assets/979bc136-a15e-48ec-8238-5e7ab6e2db2c)\r\n![image](https://github.com/user-attachments/assets/6e2c7878-1331-42e7-abc6-7194425abb63)\r\n\r\n### Profile Page\r\n![image](https://github.com/user-attachments/assets/0db391fb-d076-4a1d-8ffd-2c32d2052452)\r\n\r\n### Game Page\r\n![image](https://github.com/user-attachments/assets/dce5d48f-b17a-4d2a-9da8-7a2f5f81a286)\r\n![image](https://github.com/user-attachments/assets/bb4cbde7-a876-4268-8977-57f00d551935)\r\n![image](https://github.com/user-attachments/assets/578970e1-f3ce-428c-94c1-b1788dd537b7)\r\n\r\n#### Visit \u003ca href = \"https://board-games-two.vercel.app/\" target=\"_blank\"\u003eBoard Games\u003c/a\u003e\r\n\r\n\r\n\r\n\r\n\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprechy123%2Fboard-games","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprechy123%2Fboard-games","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprechy123%2Fboard-games/lists"}