gudofabi / bulleting-board-app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bulletin Board App

A brief description of what this project does and who it's for.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them:

Installing

A step-by-step series of examples that tell you how to get a development environment running.

Setting up the API Backend

  1. Clone the repository (if you haven't already done so):

    git clone git@github.com:gudofabi/bulleting-board-app.git
    cd your-repository
  2. Set up the API environment:

    cd path/to/api
    cp .env.dev .env

    Edit the .env file to set up your MySQL database credentials.

  3. Install dependencies:

    composer install
  4. Run database migrations and seeders:

    php artisan migrate --seed
  5. Start the API server:

    php artisan serve

    This will start the local development server at http://localhost:8000.

Setting up the Frontend

  1. Navigate to the frontend directory:

    cd path/to/frontend
  2. Set up the frontend environment:

    cp .env.example .env

    Modify the .env file as needed to match your local or development environment settings.

  3. Install frontend dependencies:

    npm install
  4. Run the development server:

    npm run dev

    This command will start the frontend development server, typically available at http://localhost:3000.

Usage

How to use the application, including any available scripts, as well as troubleshooting common issues.

Contributing

Instructions for how to contribute to the project, if applicable.

License

Specify the license under which the project is made available.

About


Languages

Language:PHP 55.2%Language:Blade 28.3%Language:Vue 9.6%Language:TypeScript 6.3%Language:JavaScript 0.4%Language:SCSS 0.0%