itsmathou / makersbnb

MakersBnB

A web application that allows users to list spaces they have available, and to hire spaces for the night.
Code with ❤️ by :

• Andrew Wood
• Becky Sedgwick
• Dave Lawes
• Esam Al-Dabagh
• Mathilde Ferrand
• Rashika Patel

MVP

Users can list spaces on the web application that are visible to all.

Technologies

This project was built with Javascript with the the MVC Express as it seemed easy to set up for a first experience.
Our testing framework is Jasmine paired with:

• Zombie to test the user experience of this web-based application
• Istanbul to get the test coverage.
  ESLint has been set up in this project (ES6 by default) to get a better knowledge of Javascript style guidelines.
  Sequelize is an ORM for Node.js.

How to install

Setting up the databases

To play with this project, you'll need to set up a test and production cloud-based databases (we used this service) with SQLite as dialect (you can also use PostreSQL, MySQL, MariaDB or MSSQL but you'll need to change some settings). Once you get the links of your databases, you need an .env at the root of the project and paste the links into it:

ENV_DATABASE=your_database_url  
ENV_TEST_DATABASE=your_test_database_url

For each database, you need two tables: users and properties. This set up will be written soon.

Setting up the project

Make sure you already have Node.js on your machine or download it from here. You can now move to the following steps:

$ git clone [email protected]:DaveLawes/MakersBnB.git  
cd MakersBNB  
npm install
node app.js

Then in your favorite browser type localhost:3000/ to access the homepage.

How to test

In your terminal:

• type npm test to run Jasmine/Zombie tests and get the test coverage
• type ./node_modules/.bin/eslint yourfile.js to run ESLint.

Test coverage after the last commit:
Statements : 95.56% ( 172/180 )
Branches : 66.67% ( 4/6 )
Functions : 91.53% ( 55/59 )
Lines : 95.51% ( 170/178 )

User Stories

As a property owner
So I can list a property
I'd like to create an account

As a property owner
So I can list a property
I'd like to add my property and some basic property details

As a user
So I can see listed properties
I'd like the web app to show all listings

As a user
So I can add another property
I want to be able to log in

As a system admin
So that I do not have unassociated properties
Only logged in users can add a property listing

Headline specifications

• Any signed-up user can list a new space. ✅
• Users can list multiple spaces. ✅
• Users should be able to name their space, provide a short description of the space, and a price per night. ✅
• Users should be able to offer a range of dates where their space is available.
• Any signed-up user can request to hire any space for one night, and this should be approved by the user that owns that space.
• Nights for which a space has already been booked should not be available for users to book that space.
• Until a user has confirmed a booking request, that space can still be booked for that night.

Nice-to-haves

• Users should receive an email whenever one of the following happens:
• They sign up
• They create a space
• They update a space
• A user requests to book their space
• They confirm a request
• They request to book a space
• Their request to book a space is confirmed
• Their request to book a space is denied
• Users should receive a text message to a provided number whenever one of the following happens:
• A user requests to book their space
• Their request to book a space is confirmed
• Their request to book a space is denied
• A ‘chat’ functionality once a space has been booked, allowing users whose space-booking request has been confirmed to chat with the user that owns that space
• Basic payment implementation though Stripe.

Team's feedbacks

This challenge has been our first group project at Makers.
We started with a MVP in Ruby/Sintra but also two spike solutions: a second MVP using Javascript/Express and an ORM paired with a cloud-based database alternative. Naturally we added an extra layer of challenge by working with a brand new stack. We have learned a lot:

• Working in team
• GitHub: branches, merging, pull requests and reviews
• Quitting VIM
• Using Node.js and Express with new testing tools

Obviously there are some drawbacks. We may have spent quite some time to set everything up and discover this new environment which could have been frustrating to understand how they work.

Appendix - team documentation

• CRC Cards
• Domain model
• Goals and Strategies
• ORM for Javascript investigation
• Testing in Node.js