Skip to content

Commit

Permalink
chore: update README.md and update version of package
Browse files Browse the repository at this point in the history
  • Loading branch information
gobeam committed Jan 18, 2022
1 parent 96e532f commit 5628228
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ https://nodejs.org/en/
Typescript
https://www.typescriptlang.org/

PostgresQL
https://www.postgresql.org/

Redis
https://redis.io/

---

## Available Scripts
Expand Down Expand Up @@ -108,11 +114,18 @@ This command is used to run existing seeders.

## Setup

First, you need to clone the project
First, you need to install the project using npx command

```bash
git clone https://github.com/gobeam/truthy.git
npx truthy-api
```

or clone it using

```bash
git clone https://github.com/gobeam/truthy.git
```
**You also need to run PostgresQL for database and Redis for key-val storage which will be used for queue and throttling.**
After cloning the make changes in configuration file that exists in config folder which exists in root of project.
File names are named in accordance with environment you run project with. For example if you're running project in development environment you should make change in configuration of development.yml file.
**Please keep in mind environment variables always overrides the config.**
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "truthy-api",
"version": "0.1.0",
"version": "0.2.0",
"description": "Truthy API",
"author": "gobeam <[email protected]>",
"license": "MIT",
Expand Down

0 comments on commit 5628228

Please sign in to comment.