Skip to content

Commit

Permalink
docs: update READMEs with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
csirianni committed Oct 18, 2023
1 parent 24911c7 commit 8e1f425
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,21 @@
# private-data-lookup
# Private Data Lookup

[![commit messages](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml/badge.svg)](https://github.com/csirianni/movie-recommender/actions/workflows/commits.yml)

## Overview

## Instructions

It's necessary to configure the `/frontend` and `/backend` folders initially. See the respective `README.md`s for more information.

In order to run the frontend, `cd` into `/frontend` and run

```console
yarn dev
```

In order to run the backend, `cd` into the `/backend` and run

```console
./build/backend
```
2 changes: 1 addition & 1 deletion backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ brew install conan cmake
conan install . --output-folder=build --build=missing
```

Set up the `/build/` folder:
Set up the `/build` folder:

```bash
mkdir build && cd build
Expand Down

0 comments on commit 8e1f425

Please sign in to comment.