Skip to content
This repository was archived by the owner on Oct 23, 2024. It is now read-only.

Commit 9f98d8c

Browse files
committed
change readme
1 parent 95a4086 commit 9f98d8c

File tree

1 file changed

+7
-54
lines changed

1 file changed

+7
-54
lines changed

README.md

Lines changed: 7 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,8 @@
1-
<div align="center">
2-
<h3 align="center">TechTest Laravel Application</h3>
3-
<a href="https://github.com/othneildrew/Best-README-Template">
4-
<img src="https://d15ywwv3do91l7.cloudfront.net/medium.webp" alt="Logo" width="80" height="80">
5-
</a>
6-
<p align="center">
7-
<br />
8-
<a href="http://ec2-54-185-223-128.us-west-2.compute.amazonaws.com" target="_blank">View Demo</a>
9-
</p>
10-
</div>
11-
12-
<!-- ABOUT THE PROJECT -->
131
## About The Project
142

15-
[![Product Name Screen Shot][product-screenshot]](http://ec2-54-185-223-128.us-west-2.compute.amazonaws.com/)
16-
17-
This repository contains a Dockerized Laravel application designed for local development. The cloud setup and deployment (AWS EC2, RDS, S3, CloudFront) were performed manually to save time. For the local environment, this setup provides a quick way to spin up and showcase the test assignment.
3+
This repository contains a Dockerized Laravel application designed for local development.
184

19-
**Note**: My primary framework is Symfony, but for this test assignment, I opted to use Laravel as specified in the requirements.
5+
**Note**: My primary framework is Symfony, but for this test assignment, I opted to use Laravel in order to express my framework independence.
206

217
<!-- GETTING STARTED -->
228
## Getting Started
@@ -38,53 +24,20 @@ Ensure you have Docker and Docker Compose installed on your machine.
3824
make build
3925
```
4026
This command will build and start the necessary Docker containers. The process may take some time.
41-
42-
3. Create the stored procedure:
43-
```sh
44-
make run-sql
45-
```
46-
This will execute the SQL script to set up the stored procedure in the MySQL container.
47-
48-
4. Access the application:
49-
50-
By default, the application will be available on port 80 of localhost. Ensure this port is available; otherwise, the build may fail.
51-
52-
Open your browser and go to http://localhost.
5327

54-
## AWS Test Environment
28+
3. Access the application:
5529

56-
The application is also deployed on an AWS test environment for one week from the submission of the test assignment. After this period, the test environment will be removed.
57-
**AWS EC2 Instance URL:**
58-
59-
http://ec2-54-185-223-128.us-west-2.compute.amazonaws.com
60-
61-
AWS services used for deployment:
30+
By default, the application will be available on port 80 of localhost. Ensure this port is available; otherwise, the build may fail.
6231

63-
- EC2 (Elastic Compute Cloud)
64-
- RDS (Relational Database Service)
65-
- S3 (Simple Storage Service)
66-
- CloudFront (Content Delivery Network)
67-
- Configuration of Security Groups
32+
Open your browser and go to http://localhost:8010.
6833

6934
## API Endpoints
7035

7136
The following API endpoints are available:
7237

73-
- GET /api/articles — Retrieve a list of all articles
74-
- POST /api/articles — Create a new article
75-
- GET /api/articles/{id} — Retrieve an article by ID
76-
- PUT|PATCH /api/articles/{id} — Update an article by ID
77-
- DELETE /api/articles/{id} — Delete an article by ID
78-
79-
## Tests
80-
![image](https://github.com/user-attachments/assets/f4c96200-52b7-45de-b640-abe5d86ccaa3)
81-
38+
- GET /validate-transaction - manual testing of the validation
8239

8340
<!-- LICENSE -->
8441
## License
8542

86-
Distributed under the MIT License.
87-
88-
<!-- MARKDOWN LINKS & IMAGES -->
89-
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
90-
[product-screenshot]: https://d15ywwv3do91l7.cloudfront.net/project_screenshot.png
43+
GNU GENERAL PUBLIC LICENSE

0 commit comments

Comments
 (0)