Giter VIP home page Giter VIP logo

boba-spots's Introduction

boba-SPOTs

Boba SPOTs it's a web app to find the best boba spots near your office.

Usage

This app has two folders, a folder named "client" which contains all the code for the frontend application built with React. Another folder named "server" which contains a Node.js application. More details below if you're interested.

To run the app

  1. Clone the repo to your local machine
  2. Navigate to the client folder and run
npm install
  1. Navigate to your server folder and run
npm install
  1. In your server folder create a .env file to store your Yelp API key, I left a .env.example file so you can see how it looks, just make sure you replace the key with your actual key.

  2. Now we can start both apps, in your server folder run

node app.js

or if you have nodemon installed (which I highly recommend for development) you can run

nodemon app.js
  1. In your client folder run
npm run dev

Additional Info

In the assets folder at the root of the project, I'm leaving some of the things I used when I was defining the scope of the project. A little mockup for the UI and an overview of the 2 systems I was going to create (client and server)

Due to the time constraint I left out the pagination feature, I prioritized staying as close to the 4 hour mark as possible.

Things I would have done given more time

These are some of the things I wanted to get in there but I couldn't fit them in the time window: pagination, some sort of basic caching (I'm assuming new boba shops aren't opening every day), testing and actually deploying the app so you could see it live

Tech Stack

  • React
  • Node.js
  • Express
  • Vite

boba-spots's People

Contributors

jpdevspace avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.