You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-18
Original file line number
Diff line number
Diff line change
@@ -10,35 +10,35 @@ that focuses on managing distributed stock for large organizations.
10
10
11
11
## Quick Start
12
12
13
-
If you want to start using StockedUp, I host fully fledged [live demo](https://stockedup.dokurno.dev).
14
-
For simplicity sake, you can also create
15
-
[a demo account](https://stockedup.dokurno.dev/register/demo) and skip registration process.
13
+
If you want to start using StockedUp, I host a fully-fledged [live demo](https://stockedup.dokurno.dev).
14
+
For simplicity's sake, you can also create
15
+
[a demo account](https://stockedup.dokurno.dev/register/demo) and skip the registration process.
16
16
17
17
## About
18
18
19
-
StockedUp is a easy to use service that allows for managing wast amounts of inventory data
19
+
StockedUp is an easy-to-use service that allows for managing vast amounts of inventory data
20
20
for logistical companies. The design philosophy is to separate product definitions from
21
-
actual stock data. This allow for separation between global changes of product details
22
-
(such as price, or description) and stock values.
21
+
actual stock data. This allows for separation between global changes of product details
22
+
(such as price or description) and stock values.
23
23
24
24
The general ideas used in StockedUp are:
25
25
26
-
-**Organization** - You can think of organization as your company.
27
-
-**Product Definition** - Information about an product. It's name, price, description, SKU.
28
-
-**Warehouse** - Representation of physical location where your company stores products. Like warehouse or a store.
29
-
-**Inventory** - A product inside a warehouses with quantity and it's location.
26
+
-**Organization** - You can think of an organization as your company.
27
+
-**Product Definition** - Information about a product. Its name, price, description, SKU.
28
+
-**Warehouse** - Representation of the physical location where your company stores products, like a warehouse or a store.
29
+
-**Inventory** - A product inside a warehouse with quantity and its location.
30
30
31
31
## Tech Stack
32
32
33
-
-[Nest.js](https://nestjs.com) - Nest.js, Typescript-based Node.js framework is used as main backend.
34
-
-[React](https://react.dev) - React.js alongside with Tailwind CSS and other client-side libraries is used as frontend library.
35
-
-[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/)
36
-
-[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.
37
-
-[Redis](https://redis.io) - Redis is used as secondary database for sessions and caching.
33
+
-[Nest.js](https://nestjs.com) - Nest.js, a TypeScript-based Node.js framework, is used as the main backend.
34
+
-[React](https://react.dev) - React.js alongside Tailwind CSS and other client-side libraries is used as the frontend library.
35
+
-[Amazon AWS](https://aws.amazon.com) - AWS is used as the primary hosting provider that handles server hosting with [EC2](https://aws.amazon.com/ec2/) and image hosting with [S3](https://aws.amazon.com/s3/).
36
+
-[MongoDB](https://www.mongodb.com) - MongoDB (with [Mongoose ODM](https://mongoosejs.com)) is the primary database used to optimize access to vast amounts of organizational data.
37
+
-[Redis](https://redis.io) - Redis is used as a secondary database for sessions and caching.
38
38
39
39
## API
40
40
41
-
StockedUp uses Rest API authenticated using session cookies. You can explore this API
41
+
StockedUp uses a REST API authenticated using session cookies. You can explore this API
42
42
using [Swagger](https://stockedup.dokurno.dev/api) or [Postman](https://app.getpostman.com):
43
43
44
44
[<imgsrc="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)
@@ -47,6 +47,6 @@ using [Swagger](https://stockedup.dokurno.dev/api) or [Postman](https://app.getp
47
47
48
48
Want to contribute to the project?
49
49
50
-
First of all, thanks! If you find and problems with the project or want to suggest a feature
50
+
First of all, thanks! If you find any problems with the project or want to suggest a feature,
51
51
don't hesitate to create [an issue](https://github.com/MrBartusek/stocked-up/issues). If you want
52
-
to contribute code changes, please create a [Pull Requests](https://github.com/MrBartusek/stocked-up/pulls).
52
+
to contribute code changes, please create [Pull Requests](https://github.com/MrBartusek/stocked-up/pulls).
0 commit comments