zduvall / Toilet-Surfing

Toilet Surfing, full-stack solo project, a clone of Couch Surfing with a focus on bathroom sharing ;)

Toilet-Surfing

Toilet-Surfing -- where chill people share their toilets with other chill people, inspired by the giving and laid-back culture of couch surfing and by good vibes of surfers in general.

First full-stack solo project. The whole site is contained on the root route /, allowing for a seamless user experience and limiting database queries.

Logged-in users can create, update, and delete toilets as well as create and delete bookings to use toilets in the future.

Try the live site here.

Visit my site wiki to see the database schema, routes, user stories, and feature list (current and planned).

Tech Stack

Toilet Surfing uses the following tools, frameworks, and key packages:

• AWS S3
• Bcryptjs
• Express-session
• Express-validator
• Express.js
• Hosted on Heroku
• Node.js
• React
• React Google Maps Api
• Redux
• Sequelize (with PostgreSQL)

Icons and fonts are from:

• Google Fonts
• Font Awesome

Run Toilet Surfing Locally

Follow these instructions to run Toilet Surfing on your local machine. Note: image uploads and map functionality will not work without a valid AWS key and AWS secret and google Maps API key.

To run the Toilet Surfing application locally, refer to the following instructions:

1. git clone this repo
2. cd into the local clone of the repository
3. cd into the backend folder and npm install
4. Create your own .env file in backend and frontend directories based on the .env.example files there
5. Create a PostgreSQL user that matches the one you identified in your backend .env file
6. Run npx dotenv sequelize db:create to create the database
7. If the sequelize module is not found, try running npx dotenv sequelize-cli db:create and replace sequelize with sequelize-cli for the rest of these commands
8. Run npx dotenv sequelize db:migrate to run the migrations
9. Run npx dotenv sequelize db:seed:all to seed the database
10. Open another terminal and cd into the frontend directory and npm install
11. Run npm start in both the terminal on your backend and frontend
12. The React server should open up a browser window with the correct address