https://github.com/quackness/lightbnb

https://github.com/quackness/lightbnb

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/quackness/lightbnb
• Owner: quackness
• Created: 2022-04-12T14:13:38.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-21T01:33:02.000Z (almost 3 years ago)
• Last Synced: 2024-11-14T08:12:00.295Z (3 months ago)
• Language: JavaScript
• Size: 2.79 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LightBnB

LightBnB is a project exploring ERD design and SQL queries as well as JavaScript API functions using SQL queries.

It has an option to register as a user, sign in. Passwords are encrypted. Its main function is having access to a web based app allowing to search for and store properties for rent. You can add a property to the pool as an owner or view your existing reservations as a guest. 

## Interface

Sign up/Log In

![Login](/pics/login.png "login")

Create listing

![Create listing](/pics/create.png "create listing")

## Getting started

* Fork this repository and clone it onto your local device.

* Install dependencies using the npm install command.

* Start the web server using the npm run local command from /ligthBnB_WebApp directory. 

* The app will be served at http://localhost:3000/ in your browser.

## Dependecies

  *  bcrypt

  *  body-parser

  *  cookie-session

  *  express

  *  nodemon	

  *  pg

  *  nodemon

## Project Structure

```

├── public

│   ├── index.html

│   ├── javascript

│   │   ├── components 

│   │   │   ├── header.js

│   │   │   ├── login_form.js

│   │   │   ├── new_property_form.js

│   │   │   ├── property_listing.js

│   │   │   ├── property_listings.js

│   │   │   ├── search_form.js

│   │   │   └── signup_form.js

│   │   ├── index.js

│   │   ├── libraries

│   │   ├── network.js

│   │   └── views_manager.js

│   └── styles

├── sass

└── server

  ├── apiRoutes.js

  ├── database.js

  ├── json

  ├── server.js

  └── userRoutes.js

```

* `public` contains all of the HTML, CSS, and client side JavaScript. 

  * `index.html` is the entry point to the application. It's the only html page because this is a single page application.

  * `javascript` contains all of the client side javascript files.

    * `index.js` starts up the application by rendering the listings.

    * `network.js` manages all ajax requests to the server.

    * `views_manager.js` manages which components appear on screen.

    * `components` contains all of the individual html components. They are all created using jQuery.

* `sass` contains all of the sass files. 

* `server` contains all of the server side and database code.

  * `server.js` is the entry point to the application. This connects the routes to the database.

  * `apiRoutes.js` and `userRoutes.js` are responsible for any HTTP requests to `/users/something` or `/api/something`. 

  * `json` is a directory that contains a bunch of dummy data in `.json` files.

  * `database.js` is responsible for all queries to the database. It doesn't currently connect to any database, all it does is return data from `.json` files.