Skip to content

Commit

Permalink
Merge pull request #64 from letehaha/chore/update-readme
Browse files Browse the repository at this point in the history
feat: Update README
  • Loading branch information
letehaha authored Jun 25, 2023
2 parents 7e07b66 + 8183592 commit bee308d
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# budget-tracker-be
Budget tracker back-end

### Run instruction
### First run instructions

Required stack (WIP): Postgres v11, Node version specified in `.nvmrc`

1. Install dependencies
```sh
npm i
```

2. Fill config with required data (like DB name, user, pass, and e.g.) for dev/prod environments
2. Fill configs in `./config` directory with required data (like DB name, user, pass, and e.g.) for dev/prod environments

3. Run migrations
```sh
Expand All @@ -27,6 +29,12 @@ npm run seed
npm run dev
```

### If you didn't work on it for long time

1. Make sure Postres v11 is running
2. Run `nvm use`
3. That's it!

### Current DB schema

![budget-tracker-schema](https://user-images.githubusercontent.com/12257282/147393125-de1c8815-023e-49d4-b337-20cfaea06552.png)

0 comments on commit bee308d

Please sign in to comment.