An open API service indexing awesome lists of open source software.

https://github.com/ruthmoog/makers_seagull-bnb


https://github.com/ruthmoog/makers_seagull-bnb

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# Seagull BnB

An accomodation listing and booking site.

## MVP User Stories

```
As a user
So that my property can be seen
I want to create a property listing on Seagull BnB
```

```
As a user
So I my property will be listed
I want to enter my property name
```

```
As a user
So that my property will be appealing
I want to give my property a description
```

```
As a user
so that other users can see my property
I want my property listing to be displayed
```

```
As a user
so that I can holiday \o/
I want to book a property
```

```
As a user
So that my property is not double-booked
I want my property to be unavailable once booked
```

## Technology

Code and content is written in:
- Ruby
- HTML
- CSS

We developed this project using BDD and TDD. For testing, we used:
- Capybara
- Rspec

Environment tools include:
- Sinatra, DSL web app framework
- Heroku, cloud platform service

## Local Set Up

### How to create a database using PSQL
- download Postgresql
- Connect to psql in terminal with `psql`
- Create the database using the psql command `CREATE DATABASE seagull;`
- Connect to the database using the pqsl command `\c seagull`
- Run the query we have saved in the file `migrations/01_create_listings_table.sql`

### Creating a test database
This is required to run the tests
- Connect to psql in terminal with `psql`
- Create the database using the psql command `CREATE DATABASE seagull_test;`
- Connect to the database using the pqsl command `\c seagull_test`
- Run the query in `migrations/01_create_listings_table.sql`

In the terminal use bundle to download the required gems:
```shell
$ bundle install
```

Run all tests in the terminal with RSpec:
```shell
$ rspec
```

## Features Under Construction

We plan to use a reserved button which will update the available status of the related property in the database.

## Acknowledgements

This code was created by Seagull Dynamics, Ben + Joe + Lucian + Ruth.
Thanks for support and advice from Bart, Ed, Chris and the May 19 Makers cohort.