README.md

GoofyKooks

What is it?

GoofyKooks is a clone of the popular web app Yelp built with the surfing community in mind.

Developing

To run this application locally, you'll need to:

1. git clone this repo

   git clone https://https://github.com/markhv-code/GoofyKooks

2. cd into the local repo

   cd GoofyKooks

3. npm install to install the dependencies

   npm install

4. Create a .env file based on the .env.example file included in the repo with your own values

5. Create a user on your local machine with the username and password specified in your .env file in PostgreSQL

6. Run npx dotenv sequelize db:create to create the database

    npx dotenv sequelize db:create

• 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

    npx dotenv sequelize-cli db:create

7. Run npx dotenv sequelize db:migrate to run the migrations

    npx dotenv sequelize db:migrate

8. Run npx dotenv sequelize db:seed:all to seed the database

    npx dotenv sequelize db:seed:all

9. Finally, start the development server with npm start. The scripts in the package.json should do the work. You'll see the local address you can use show up in the terminal.

    npm start

Technologies Used

• PostgreSQL
• Express.js
• React
• Redux
• JavaScript
• Tailwind CSS Framework
• Bcryptjs
• Express-session
• Express-validator
• Node.js

Live Site

Here's a link to our live app!

Documentation

Here's a link to our Wiki!