Skip to content

Commit

Permalink
chore: update README, UI improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Chriscbr committed Feb 12, 2024
1 parent b14c87d commit e1e4fed
Show file tree
Hide file tree
Showing 4 changed files with 494 additions and 52 deletions.
46 changes: 18 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,37 @@
# Battle of the Bites!

**_Get ready to indulge your taste buds and crown the ultimate culinary champion in Battle of the Bites!_** 🍔🍕🍣
Swipe, vote, and savor the showdown as iconic dishes from around the world go head-to-head in a gastronomic clash like no other.
Will pizza outflavor sushi?
Can burgers grill their way to victory over tacos?
Join the epic feast and help your favorite bites seize their rightful spot on the podium of delicious dominance.
Welcome to the ultimate flavor face-off!
Vote on different matchups as iconic dishes from around the world go head-to-head.

Check out the app's demo at https://d150bm8l5c4qqp.cloudfront.net/.
<center>
<b><a href="https://d1uu5g7pkrzn0o.cloudfront.net/">Live Demo</a></b>
</center>
<br>

![Battle of the Bites screenshot](screenshot.png)
[![Battle of the Bites screenshot](screenshot.png)](https://d1uu5g7pkrzn0o.cloudfront.net/)

Inspired by https://eloeverything.co/.

## Development

### Deployment
### Testing

To deploy your own copy of the app, first make sure you have AWS credentials configured in your terminal for the account and region you want to deploy to.
Then:
You can test the web app locally using Wing Console.

1. Clone this git repository.
2. Compile the project to AWS (with Terraform) using `wing compile -t tf-aws main.w`.
3. Run `cd target/main.tfaws` to find your deployment artifacts.
4. Run `terraform init` and `terraform apply`.
1. Run `npm run build-react` to build the website.
2. Run `wing it main.w` to launch the Wing Console in your browser.
3. In the Wing Console, locate the website resource, and click on it to see its properties on the right sidebar. Click on the URL property to open visit the website in your browser.

### Website
### Deployment

1. Clone this git repository.
2. Run `cd website`.
3. Run `npm install`.
4. Run `npm run build`,
5. Create a file at `website/public/config.json` that contains the following:
To deploy your own copy of the app, first make sure you have AWS credentials configured in your terminal for the account and region you want to deploy to.
Then run the following commands to compile the app into Terraform, and deploy it:

```json
{
"apiUrl": "<API GATEWAY URL>",
}
```

Replace <API GATEWAY URL> with the URL of the API Gateway that was created when you deployed the app.

5. Run `npm run start` from `website` to start the development server. Any changes you make to the website will be automatically reflected in the browser.
wing compile -t tf-aws main.w
terraform -chdir=./target/main.tfaws init
terraform -chdir=./target/main.tfaws apply
```

## Contributions

Expand Down
Loading

0 comments on commit e1e4fed

Please sign in to comment.