Skip to content

rileygrotenhuis/corvesive

Repository files navigation

Corvesive

Budgeting made simple.

Prerequisites

Before you can run this application, ensure you have the following software installed on your system:

  1. PHP: This application requires the latest version of Php to run. You can download and install PHP from the official website. Ensure you have the latest version of PHP by running the following command:

    php --version
  2. Composer: Composer is used to manage and install dependencies for PHP. You can download and install Composer from the official website. Ensure you have the latest version of Composer by running the following command:

    composer --version
  3. Docker: This application is containerized by utilizing Docker. You can follow the instructions provided by the Docker team to install it on your machine on their official documentation. Ensure you have the latest version of Docker by running the following command:

    docker --version
  4. Docker Compose: Docker Compose is a tool used in tandem with Docker for defining and running multi-container Docker applications. You can follow the instructions provided by the Docker team to install it on your machine on their official documentation. Ensure you have the latest version of Docker by running the following command:

    docker-compose --version
  5. Node: This application requires Node.js to compile assets. You can download and install Node.js from the official website. Ensure you have the latest version of Node.js by running the following command:

    node --version

Installation

To get started with this application, follow these steps:

  1. Navigate to the Project Directory: Change your working directory to the newly cloned repository:

    cd corvesive
  2. Copy Environment Variables: This application uses environment variables for configuration. Copy the contents from the .env.example file into a .env file.

    cp .env.example .env
  3. Install Dependencies: Now you need to install the project dependencies using Composer. Run the following command:

    composer install
  4. Generate Encryption Key: To generate an encryption key that the Laravel application uses for authentication and authorization, run the following command:

    php artisan key:generate
  5. Start the Application: Once the dependencies are installed, you can start the application by running:

    ./vendor/bin/sail up -d
  6. Run Migrations: To run the database migrations for this application, run the following command:

    ./vendor/bin/sail artisan migrate
  7. Compile Assets: To compile the assets for this application, run the following command:

    npm install
    npm run dev