Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sxflynn authored Nov 18, 2023
1 parent 4d58280 commit b215714
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# sideprojectstarter
Kickstart your full stack side project with a Spring Boot / PostgreSQL / Vue container setup.

## Instructions

### 1. Download and Install Docker

- Download and install Docker for your operating system from the [Docker Downloads](https://www.docker.com/products/docker-desktop) page.

### 2. Clone the Repository

- Open a terminal or command prompt.
- Navigate to the directory where you want to store your project.
- Clone the "sideprojectstarter" repository from GitHub using the following command:

`git clone https://github.com/sxflynn/sideprojectstarter.git`


### 3. Start Containers

- Change your working directory to the project folder:

`cd sideprojectstarter`

- Start the Docker containers using `docker-compose`:

`docker-compose up`


### 4. Access the Vue Project

- Once the containers are up and running, your Vue.js project should be accessible at `localhost:5173` in your web browser.

Now, you have successfully set up your full stack side project with Spring Boot, PostgreSQL, and Vue.js using Docker containers. You can start developing your application by editing the code in the project directory.

0 comments on commit b215714

Please sign in to comment.