Skip to content

Commit 950da04

Browse files
committed
Completed Readme
1 parent c16389c commit 950da04

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Glad that you asked. CrudJS intends to be a resource for comparing between diffe
1010

1111
You can learn more about the project at [our parent repository](https://github.com/crudjs/crudjs).
1212

13+
## Trying out the API
14+
### On your local machine
15+
You'll need [Docker](https://www.docker.com/) for that. Once you've got it installed on your machine, just clone the repo and run the `docker-compose up --build` command. The API will be listening for your requests at `http://localhost`.
16+
17+
### On the cloud
18+
We're still working on a deployment strategy that works for us. Stay tuned!
19+
1320
## What's the stack used in this project?
1421
- **[Nest.js](https://nestjs.com/)** is a [TypeScript](https://www.typescriptlang.org/)-based Node.js API framework. It looks like if Angular and Express got physical. It's pretty knew and a bit rough around the edges, but [Kamil Myśliwiec](https://github.com/kamilmysliwiec) is doing an awesome job maintaining it.
1522
- **[Postgres](https://www.postgresql.org/)** is a very well know Open Source relational database.
@@ -21,4 +28,4 @@ You can learn more about the project at [our parent repository](https://github.c
2128
*What's missing for 1.0.0 final?*
2229
- Unit tests with mocked up dependencies.
2330
- Secured POST & DELETE endpoints (other that /entries.)
24-
- Swagger definition generated from code.
31+
- Swagger definition generated from code.

0 commit comments

Comments
 (0)