Skip to content

Commit

Permalink
Completed Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
davguij committed Oct 20, 2017
1 parent c16389c commit 950da04
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ Glad that you asked. CrudJS intends to be a resource for comparing between diffe

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

## Trying out the API
### On your local machine
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`.

### On the cloud
We're still working on a deployment strategy that works for us. Stay tuned!

## What's the stack used in this project?
- **[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.
- **[Postgres](https://www.postgresql.org/)** is a very well know Open Source relational database.
Expand All @@ -21,4 +28,4 @@ You can learn more about the project at [our parent repository](https://github.c
*What's missing for 1.0.0 final?*
- Unit tests with mocked up dependencies.
- Secured POST & DELETE endpoints (other that /entries.)
- Swagger definition generated from code.
- Swagger definition generated from code.

0 comments on commit 950da04

Please # to comment.