A 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
- User Profiles: Create a personalized profile.
- Real Time: Get updated values Real-Time without need to refresh page.
- Board Game: Play your favourite board games with your friends and family.
To get a local copy up and running, follow these simple steps.
Before you proceed, ensure that you have the following prerequisites installed:
- Node.js and npm: Download and Install Node.js
- MongoDB: Download and Install MongoDB
- Git: Download and Install Git
mern-food-website/
├── server/
│ └── ...
├── client/
│ └── ...
├── LICENSE
└── readme.md
Ensure you are using the latest node version
- Navigate to the
server
directory:cd server
. - Install dependencies: Run
npm install
. - Create a
.env
file in thebackend
directory and add the following environment variables:
PORT = 5000
MONGO_URI = your_mongodb_connection_string
JWT_SECRET = Your_jwt_secret_phrase
EMAIL_USER= Your mail for nodemailer email address
EMAIL_PASSWORD= Your nodemailer app password (Note: This is not the email password)
BASE_URL= Your frontend route (e.g. http://localhost:3000)
CLOUDINARY_NAME = Your_cloudinary_name
CLOUDINARY_APIKEY = Your_cloudinary_apikey
CLOUDINARY_APISECRET = Your_cloudinary_apisecret
CLOUDINARY_URL = Your_cloudinay_url
Replace your_mongodb_connection_string
with your MongoDB connection string, and Your_jwt_secret_phrase
with a secret key for JWT authentication.
-
Configure cloudinary account
-
Start the Express.js server: Run
npm run dev
.
- Navigate to the
client
directory:cd client
. - Install dependencies: Run
npm install
. - Create a
.env.local
file in theclient
directory and add the following environment variables:
NEXT_PUBLIC_BACKEND_URL = Your server url (e.g. http://localhost:5000)
NEXT_PUBLIC_JWT_SECRET = Your JWT secret
- Start the React frontend: Run
npm run dev
.
- Access the website at
http://localhost:3000/
.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you'd like to contribute to this project, follow the following steps:-
- Fork the Project
- clone the repository
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some Amazing Feature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request