ConnectMe is a Laravel-based web application that allows users to connect with others, share information, and collaborate on various projects. This README file provides instructions on how to set up and configure the ConnectMe application on your local development environment.
To get started with ConnectMe, follow the steps below:
Before you begin, ensure you have the following software installed on your local machine:
- PHP (recommended version: 7.4 or higher)
- Composer
- MySQL or SQLite for the database
- Node.js and npm for frontend assets
-
Clone the ConnectMe repository from GitHub:
git clone https://github.com/tauseedzaman/connectme.git
-
Change into the project directory:
cd connectme
-
Install PHP dependencies using Composer:
composer install
-
Copy the
.env.example
file to.env
:cp .env.example .env
-
Generate an application key:
php artisan key:generate
-
Configure your database connection settings in the
.env
file. You'll need to set the following variables:DB_CONNECTION=mysql DB_HOST=your_database_host DB_PORT=your_database_port DB_DATABASE=your_database_name DB_USERNAME=your_database_username DB_PASSWORD=your_database_password
Replace the placeholders with your actual database information.
-
Migrate the database to create the necessary tables:
php artisan migrate
-
Install JavaScript dependencies using npm:
npm install
-
Compile frontend assets:
npm run dev
-
Start the development server:
php artisan serve
By default, the application will be accessible at
http://localhost:8000
.
You can now access the ConnectMe application in your web browser. You can register an account, log in, and start using the features of the application.
If you'd like to contribute to ConnectMe, please follow our contribution guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
- Thank you to the Laravel community for providing an excellent PHP framework.
- Special thanks to the ConnectMe development team for their hard work on this project.
For any issues or questions, please open an issue on GitHub.
Enjoy using ConnectMe!