A brief description of what this project does and who it's for.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
- Node.js and npm (https://nodejs.org)
- PHP and Composer (https://getcomposer.org/)
- MySQL (https://www.mysql.com/)
A step-by-step series of examples that tell you how to get a development environment running.
-
Clone the repository (if you haven't already done so):
git clone git@github.com:gudofabi/bulleting-board-app.git cd your-repository
-
Set up the API environment:
cd path/to/api cp .env.dev .env
Edit the
.env
file to set up your MySQL database credentials. -
Install dependencies:
composer install
-
Run database migrations and seeders:
php artisan migrate --seed
-
Start the API server:
php artisan serve
This will start the local development server at http://localhost:8000.
-
Navigate to the frontend directory:
cd path/to/frontend
-
Set up the frontend environment:
cp .env.example .env
Modify the
.env
file as needed to match your local or development environment settings. -
Install frontend dependencies:
npm install
-
Run the development server:
npm run dev
This command will start the frontend development server, typically available at http://localhost:3000.
How to use the application, including any available scripts, as well as troubleshooting common issues.
Instructions for how to contribute to the project, if applicable.
Specify the license under which the project is made available.