tawebbcn/m2-project-structure-jsx

spaceOut!

Description

​ SpaceOut is a user-friendly platform enabling you to find and book a co-working space on an hourly rate. Change your office environment as often as you want choosing among various options in your area!

​ You can become a space provider by listing your unused equipped space. Convert those square meters into your passive income!

User Stories

• As a user, I want view various spaces options directly on the home page
• As a user, I want to be able to search for spaces using my custom criteria
• As a user, I want to be able to view available spaces that fit my search criteria on the search results page
• As a user, I want to be able to view the space search result located on a map on the search results page
• As a user, I want to be able to update the search criteria on the search results page
• As a user, I want to be able to create, edit and delete my account on my account page
• As a user, I want to be able to authenticate myself on the authentication page
• As a space provider, I want to be able to create, edit and delete my space on my space page
• As a client, I want to be able to book a space on the space page
• As a user, I want to be able to cancel my booking in my profile view
• As a user, I want to be able to view my upcoming bookings on my profile page
• As a user, I want to be able to view my booking history on my profile page
• As a user, I want to be able to familiarize with the answers to frequently asked questions on the FAQ page

Server Routes

Method	Route	Description	Request - Body
GET	/	Homepage
GET	/auth	Renders the Authentication Page
POST	/auth/signup	Creates a New User Account, Appends a New User Document to the Database and Redirects the User to the Previously Viewed Page	{username, email, password, dateOfBirth}
POST	/auth/login	Authenticates an Existing User and Redirects the User to the Previously Viewed Page	{username, email, password, dateOfBirth}
POST	/auth/logout	Destroys the Session and Redirects Unauthenticated User to Homepage	{id}
GET	/search	Renders Search Result Page
GET	/space/:id	Space Details Page
GET	/user	Renders Profile Page of the User
GET	/user/edit
POST	/user/edit	Updates User's Profile Info and Refreshes the Profile Page after Editing	{imageUrl, username, phoneNumber, dateOfBirth}
POST	/user/delete	Deletes User's Profile and Redirects to Homepage Unauthenticated	{_id}
GET	/user/space/add	Renders a Form to Create and Publish a Space
POST	/user/space/add	Adds New Space to DB and Refreshes the Space Page	{[imageUrl], name, address, locationUrl, capacity, welcomePhrase, [amenities], pricePerHour, priceCurrency, discount}
GET	/space/:id	Renders Space View
GET	/user/space/edit/:id	Renders Space Edit View
POST	/user/space/edit/:id	Updates Provider's View of Space Page and Refreshes the Space Info after Editing	{[imageUrl], name, address, locationUrl, capacity, welcomePhrase, [amenities], pricePerHour, priceCurrency, discount}
POST	/user/space/delete/:id	Deletes the Space and Redirects Provider to Their Profile Page	{_id}
GET	/user/space/book/:id	Renders Booking Page
POST	/user/space/book/:id	Creates a Booking and Redirects User to their Profile Page	{clientID, spaceID, startDate, endDate, priceAmount, priceCurrency, discount}
POST	/user/booking/cancel/:id	Cancels the Booking and Refreshes User's Profile Page
GET	/faq	Renders the FAQ Page

Models

User Model

{
     "username": { type: String, required: true},
     "email": {type: String, required: true},
     "password": {type: String, required: true},
     "imageUrl": String,
     "dateOfBirth": String,
     "phoneNumber": [{type: String}],
     "bookingHistory": [{type: Schema.Types.ObjectId, ref:"Booking"}],
     "isProvider": Boolean,
     "spaces": [{type: Schema.Types.ObjectId, ref:"Space"}],
     "reviews": [{reviewID: {type: Schema.Types.ObjectId, ref:"Review"}}]
}

Space Model

{	"title": String,
    "description": String,
    "contactInfo": String,
    "locationUrl": String,
    "address": String,
    "city": String,
    "capacity": Number,
    "providerID": [{type: Schema.Types.ObjectId, ref:"User"}],
    "rating": Number,
    "isActive": Boolean,
    "availToday": Boolean,
    "imageUrl": [String],
    "welcomePhrase": String,
    "amenities": [{type: String, enum: ['WiFi', 'WC', 'Coffee Machine', 'Refrigerator', 'Climate Control', 'Phone Booth', 'Terrace', 'Indoor Smoking Patio', 'Ergonomic Equipment', 'Kitchen', 'Canteen']}],
    "pricePerHour": Number,
    "discount": {type: Number, min:0, max:1, default:0},
    "reviews": [{reviewID: {type: Schema.Types.ObjectId, ref:"Review"}}]
}

Booking Model

{
        clientID: {type: Schema.Types.ObjectId, ref:"User"},
        spaceID: {type: Schema.Types.ObjectId, ref:"Space"},
        startDate: String,
        endDate: String,
        durationInHours: Number,
        priceAmount: Number,
        discount: Number,
        cancelled: {
            date: String, 
            cancelledBy: {type: Schema.Types.ObjectId, ref:"User"}, 
            refund: {type:Number, default: 0}
        },
        review: {type: Schema.Types.ObjectId, ref:"Review"}
}

Backlog

• Built-in messenger
• Notifications
• Reviews
• Booking modification

Links

Git

Repository Link

Deploy Link

Planning

Our Trello Board

Wireframes

Presentation

Check out our slides