Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ezlandau authored Oct 6, 2023
1 parent bec1b57 commit 77f3ec4
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
Sample
# Vue Website and Spring Lambda Backend for Email Service

This repository contains two main components:
1. `main-website` - A [Personal Website](https://egorzadorin.com) built using VueJS, HTML and CSS.
2. `spring-lambda` - A frontend component for an [Email Service](https://github.com/EgorZadorin/poc-aws-lambda-spring-boot), built using same technical stack.

Both applications are included in a single repository for the convenience of using GitHub Actions to automatically deploy them to an AWS EC2 instance on each git push.

## Prerequisites

- Node.js and npm for both `main-website` and `spring-lambda`

## Build and Run

Navigate to the `main-website` or `spring-lambda` directory and execute the following commands:
```
npm install
npm run serve
```

## Contribution

If you find any issues or have suggestions for improvements, feel free to open an issue or make a pull request.

## License

MIT

0 comments on commit 77f3ec4

Please sign in to comment.