Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tyler-goodwin committed Jul 11, 2020
1 parent 503ba72 commit 1385e58
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# cardboardvr

## Getting Started
To run, we require `docker` and `docker-compose` installed on linux.
To run, we require `docker` and `docker-compose` installed (tested on PopOS).

First time setup:
```bash
docker-compose run --rm backend rake db:create db:migrate
docker-compose run --rm backend rake db:create db:migrate db:seed
```

Starting dev environment:
```bash
docker-compose up -d
```

Website can now be accessed at http://localhost:8080

To run tests:
```bash
docker-compose run --rm backend rails t
```

Stopping:
```bash
docker-compose down
Expand All @@ -24,16 +28,11 @@ docker-compose down
## Assumptions
I have made the following assumptions during development:
1. Auth isn't required
2. Whole dollar price amounts only supported

## Design Decisions


### API Endpoints

2. Assume mobile responsiveness is not a priority
3. Assume it is okay to run frontend & backend in development mode (for purpose of demo only)


## Acknowledgments

Docker setup based on:
Docker setup adapted from:
https://github.com/adaam2/docker-rails-react-starter

0 comments on commit 1385e58

Please sign in to comment.