Checkmate is an application designed to help you manage your connections with long-distance loved ones. With Checkmate, you can stay in touch, plan activities, and keep track of important milestones with ease.
- Connection Management: Easily add and manage your connections with long-distance loved ones.
- Activity Planning: Plan and schedule activities to do together, whether it's watching a movie, playing a game, or simply having a video call.
- Milestone Tracking: Keep track of important milestones, such as birthdays, anniversaries, or special events, and get reminders to make sure you don't miss them.
- Real-Time Notifications: Receive real-time notifications for new messages, activity invitations, and upcoming milestones.
- User-friendly Interface: Enjoy a clean and intuitive user interface that makes it simple to navigate and use Checkmate.
To run Checkmate locally, ensure that you have the following installed:
- Node.js
- npm (Node Package Manager)
Follow the steps below to set up and run Checkmate on your local machine:
# Clone the repository
git clone https://github.com/your-username/checkmate.git
# Navigate to the project directory
cd checkmate
# Install the dependencies
npm install
# Start the development server
npm run devThis will launch the Checkmate application on your local server. Open your web browser and visit http://localhost:3000 to access Checkmate.
We welcome contributions from the community! If you'd like to contribute to Checkmate, please follow these guidelines:
- Fork the repository.
- Create a new branch.
- Make your changes and commit them.
- Push your changes to your forked repository.
- Open a pull request, providing a detailed description of your changes.
- Please ensure that your contributions adhere to our code of conduct.
Checkmate comes with a test suite to ensure the application's functionality remains robust. Run the tests using the following command:
npm testCheckmate is released under the MIT License.