Skip to content

Latest commit

 

History

History
109 lines (89 loc) · 5.29 KB

README.md

File metadata and controls

109 lines (89 loc) · 5.29 KB

cafFIEND

fueling your coffee craze.

Public repository link: https://github.com/impana-c/cafFIEND

Inspired by Yelp, cafFIEND is a minimalistic website about all things coffee-shop related. cafFIEND is dedicated to coffee enthusiasts, providing a platform to discover and review coffee shops nearby. Users can explore a curated selection of coffee establishments, read and write reviews, and learn info about crucial features for each cafe. The website aims to create a community of coffee lovers sharing their experiences and recommendations to help others find the perfect coffee spot wherever they go.

cafFIEND is implemented as a MERN stack, using MongoDB, Express.js, React.js, and Node.js.

Installation and Setup

MongoDB Setup

Please follow the instructions in the link HERE to install MongoDB. Also, please follow the instructions to start the server as well. Make sure you are using the correct instructions for your specific Operating System.

Cloning the project

git clone https://github.com/impana-c/cafFIEND.git
cd cafFIEND

Starting app with shell script

You will need to be able to run bash and chmod linux command.

chmod u+x start.sh
./start.sh

Starting app without shell script

Installing dependencies for the client

pip install pymongo
python3 insert.py
cd App/client
npm install
npm i express cors mongoose dotenv nodemon concurrently 
npm install react-icons bootstrap axios react-router-dom 
npm install @react-google-maps/api

Installing dependencies for the server

cd ../server
npm init -y
npm install express mongoose cors nodemon

Installing UI dependencies

cd ../client
npm install @mui/icons-material f
cd ..
npm install @mui/material @mui/styled-engine-sc styled-components f

Starting the app (after all installations)

(Make sure to run: sudo killall -9 node on terminal if any node processes were previously running.) (Assuming you are in the cafFIEND repo folder)

cd App/client
npm run dev

Putting in Google Maps API Key

Replace "YOUR_API_KEY" in the App/client/index.html and App/client/src/Search/Template.jsx files with your Google Maps API Key.

If you have access:

Use an API key from this document

Otherwise, create your own API key:

  1. Go to Google’s credential page: Credentials Page
  2. Create a project and setup account (will ask for billing information, just fill it out it will be free).
  3. Select the project you want for this app.
  4. Fill out the dialog boxes and an API key should show up.
  5. Copy the API key.
  6. Make sure that the key is only restricted to the localhost website you open the app on (will show up when doing npm run run dev like "http://localhost:5173/searchresult")

Website Preview

SignIn

Screen Shot 2024-03-24 at 4 43 24 PM Screen Shot 2024-03-24 at 4 44 53 PM

Home & Search

Screen Shot 2024-03-24 at 4 45 26 PM Screen Shot 2024-03-24 at 4 46 33 PM

Coffee Shop Info & Ratings

Screen Shot 2024-03-24 at 4 47 10 PM Screen Shot 2024-03-24 at 4 48 50 PM Screen Shot 2024-03-24 at 4 49 02 PM

Top Rated

Screen Shot 2024-03-24 at 4 49 18 PM

Profile

Screen Shot 2024-03-24 at 4 49 54 PM Screen Shot 2024-03-24 at 4 50 13 PM

Contributors

cafFIEND was developed by:

Acknowledgements

cafFIEND is a project that was primarily inspired by Yelp.