Skip to content

Latest commit

 

History

History
102 lines (67 loc) · 4.49 KB

README.md

File metadata and controls

102 lines (67 loc) · 4.49 KB
Raw

Coffee Compass

Users can search for coffee shops and upvote them for others to see. The project also features an Airtable database that makes it easier to access and manage the information.

This is a Next.js project bootstrapped with create-next-app.

🔥 Deployed Link

This project is hosted on Vercel Platform. Visit the following link to view the web application.

https://coffee-project-anmol-baranwal.vercel.app/

✅ Guidelines to run web app locally

  • For this app to work, you need to configure the following environment variables in your .env file in the root directory.
NEXT_PUBLIC_FOURSQUARE_PLACES_API_KEY=<value>
NEXT_PUBLIC_UNSPLASH_ACCESS_API_KEY=<value>
NEXT_PUBLIC_UNSPLASH_SECRET_API_KEY=<value>
AIRTABLE_WEB_API_KEY=<value>
AIRTABLE_BASE_KEY=<value>
  • Use these commands to run the application
# to install dependencies 
npm install

# to run the server
npm run dev
  • Open http://localhost:3000 with your browser to see the application.

🚀 Complex Features

  • Employed serverless functions to generate API responses, allowing for efficient and scalable data retrieval.

  • Utilized useSWR to effectively fetch data from an Airtable database, streamlining the data fetching process.

  • Implemented both client side rendering and server side rendering with useContext, resulting in a seamless and user-friendly experience.

  • Employed various cutting-edge techniques, including lazy loading, preloading, and lighthouse, to optimize website performance.

  • Ensured the highest level of code quality and error detection by using lint, resulting in a flawless end product.

bullseye Frameworks & Tools

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.