Skip to content

Application Setup

Jump to bottom
Lois Onyinyemme Bassey edited this page Mar 20, 2024 · 2 revisions

How to set up this project locally

The installation process for this project has been simplified through the use of a Makefile. All you need do is run a single make command and this project will be setup on your computer.

Before You Proceed: Before you proceed, ensure Docker is installed on your computer. If not, go to the official Docker website and follow the instructions on there.

Once Docker is installed, follow these steps:

  1. Clone the Repository: Clone this repository to your local machine:

    git clone [email protected]:ThatLadyDev/microservices-api.git

  2. Set Up the Application: Run the following command to set up the application:

    make setup:app

    This command automates the setup process for your application, including pulling necessary Docker images, creating containers, setting up Composer, installing dependencies, generating encryption keys, configuring Supervisor, and setting up the database.

  3. Access the Application: If all services and containers are created successfully, you can interact with the API using your preferred API testing tool, such as Postman etc.

    Use the following base URL to send requests to the API:

    http://localhost:6745

    You should see this below on successful installation:

Clone this wiki locally