Skip to content

Commit 3c18f23

Browse files
committed
Update README.md
1 parent 4f48162 commit 3c18f23

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
1-
# stocked-up
1+
# StockedUp
22

33
[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/MrBartusek/stocked-up/ci.yaml)](https://github.com/MrBartusek/stocked-up/actions)
4-
[![codecov](https://codecov.io/github/MrBartusek/stocked-up/graph/badge.svg?token=pQC25vzuqW)](https://codecov.io/github/MrBartusek/stocked-up)
4+
[![codecov](https://codecov.io/gh/MrBartusek/stocked-up/graph/badge.svg?token=pQC25vzuqW)](https://codecov.io/gh/MrBartusek/stocked-up)
5+
6+
> StockedUp is complete Inventory Management System that focuses on managing stock for large
7+
> organization with multiple warehouses.
8+
9+
![cover](https://i.imgur.com/2xOyilY.png)
10+
11+
## Tech Stack
12+
13+
- **Nest.js** - Nest.js, Typescript-based Node.js framework is used as main backend.
14+
- **React** - React.js alongside with Tailwind CSS and other client-side libraries is used as frontend library.
15+
- **Amazon AWS** - AWS is used as primary hosting provider that handles server and images hosting.
16+
- **MongoDB** - MongoDB document database is primary database used to optimize access to wast amount of organization data.
17+
- **Redis** - Redis is used as secondary database for sessions and caching.
18+
19+
### Hosting
20+
21+
This project is designed to run on AWS using following services:
22+
23+
- [EC2](https://aws.amazon.com/ec2/) - for hosting server
24+
- [S3](https://aws.amazon.com/s3/) - for attachments and profile pictures
25+
- [IAM](https://aws.amazon.com/iam/) - for access management

0 commit comments

Comments
 (0)