Skip to content

Commit a62cad7

Browse files
committed
Add more information to Readme
1 parent 28fa64f commit a62cad7

File tree

1 file changed

+42
-16
lines changed

1 file changed

+42
-16
lines changed

README.md

+42-16
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,51 @@
1-
# StockedUp
1+
# StockedUp | [Live Demo](https://stockedup.dokurno.dev)
22

3-
[![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/gh/MrBartusek/stocked-up/graph/badge.svg?token=pQC25vzuqW)](https://codecov.io/gh/MrBartusek/stocked-up)
3+
[![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) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fstockedup.dokurno.dev&link=https%3A%2F%2Fstockedup.dokurno.dev)](https://stockedup.dokurno.dev)
4+
[![codecov](https://codecov.io/gh/MrBartusek/stocked-up/graph/badge.svg?token=pQC25vzuqW)](https://codecov.io/gh/MrBartusek/stocked-up) [![Docker Image Version](https://img.shields.io/docker/v/mrbartusek/stocked-up/latest?label=docker%20version&link=https%3A%2F%2Fhub.docker.com%2Frepository%2Fdocker%2Fmrbartusek%2Fstocked-up)](https://hub.docker.com/repository/docker/mrbartusek/stocked-up/general)
55

6-
> StockedUp is complete Inventory Management System that focuses on managing stock for large
7-
> organization with multiple warehouses.
6+
[![cover](https://i.imgur.com/2xOyilY.png)](https://stockedup.dokurno.dev)
87

9-
![cover](https://i.imgur.com/2xOyilY.png)
8+
[**StockedUp**](https://stockedup.dokurno.dev) is a complete Inventory Management System that focuses on managing distributed stock for large organizations.
9+
10+
## Quick Start
11+
12+
If you want to start using StockedUp, I host fully fledged [live demo](https://stockedup.dokurno.dev).
13+
For simplicity sake, you can also create [a demo account](https://stockedup.dokurno.dev/register/demo) and
14+
skip registration process.
15+
16+
## About
17+
18+
StockedUp is a easy to use interface that allows for managing wast amounts of inventory data
19+
for logistical companies. The design philosophy is to separate product definitions from
20+
actual stock data in warehouses. This allow for global changes of product details (such as price, or description)
21+
to be reflected across all warehouses.
22+
23+
The general ideas used in StockedUp are:
24+
25+
- **Organization** - You can think of organization as your company. It hosts all of the information about it.
26+
- **Product Definition** - Information about an product. It's name, price, description, SKU.
27+
- **Warehouse** - Representation of physical location where your company stores products. Like warehouse, port or a shop.
28+
- **Inventory** - A product inside a warehouses with quantity and it's location.
1029

1130
## Tech Stack
1231

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.
32+
- [Nest.js](https://nestjs.com) - Nest.js, Typescript-based Node.js framework is used as main backend.
33+
- [React](https://react.dev) - React.js alongside with Tailwind CSS and other client-side libraries is used as frontend library.
34+
- [Amazon AWS](https://aws.amazon.com) - AWS is used as primary hosting provider that handles server hosting with [EC2](https://aws.amazon.com/ec2/) and images hosting with [S3](https://aws.amazon.com/s3/)
35+
- [MongoDB](https://www.mongodb.com) - MongoDB (with [mongose ODM](https://mongoosejs.com)) is primary database used to optimize access to wast amount of organization data.
36+
- [Redis](https://redis.io) - Redis is used as secondary database for sessions and caching.
37+
38+
## API
39+
40+
StockedUp uses Rest API authenticated using session cookies. You can explore this API
41+
using [Swagger](https://stockedup.dokurno.dev/api) or [Postman](https://app.getpostman.com):
42+
43+
[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://app.getpostman.com/run-collection/7055992-d02d47d4-a08a-4d91-99c0-1cbe6f5b2ab7?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D7055992-d02d47d4-a08a-4d91-99c0-1cbe6f5b2ab7%26entityType%3Dcollection%26workspaceId%3D264913a4-bcdd-4e43-847c-1e8cbca3334b)
1844

19-
### Hosting
45+
## Contributing
2046

21-
This project is designed to run on AWS using following services:
47+
Want to contribute to the project?
2248

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
49+
First of all, thanks! If you find and problems with the project or want to suggest a feature
50+
don't hesitate to create [an issue](https://github.com/MrBartusek/stocked-up/issues). If you want
51+
to contribute code changes, please create a [Pull Requests](https://github.com/MrBartusek/stocked-up/pulls).

0 commit comments

Comments
 (0)