Skip to content

Korean Food Delivery App - Group Project for General Assembly Software Engineering Immersive

Notifications You must be signed in to change notification settings

Sean994/JiakSEOM

Repository files navigation

Jiak-섬 (JiakSEOM)

A food delivery platform catered specifically for South Korean cuisine, built with Reactjs, Express, MongoDB.

Jiak-섬


✏️ Description


We set out to build an online food delivery app, specifically tailored towards Korean restaurants. We were introduced to a mobile app and website called Yellowsing which was built for Korean expatriates in Singapore, but were frustrated to discover that it did not have an in-app delivery option. We opted to solve that ourselves by building a food delivery platform with a slick interface, enabling anyone to get a taste of Korea at the click of a button!

Please see presentation.md for a demo!


Why the name JiakSEOM?

JiakSEOM image

It's simple, really. "Jiak", in Singlish, means "to eat", while "섬" (seom), in Korean, means "island".

We Singaporeans normally invite our elders, family, and friends to eat by uttering "jiak" before every meal.

Hence, we thought it best to juxtapose both Singlish and Korean together by combining the term "jiak" with "섬", where you can find food on the island of Singapore.


💻 Technologies


  • Javascript
  • React
    • React Router
    • React Tabs
  • Express
  • Mongoose
  • MongoDB
  • Bootstrap
    • React Bootstrap
  • Query-String
  • Font-Awesome
  • Axios

🛠 Installation


  1. Clone the repo & Install NPM packages
git clone <current git repository>
cd teamKorea
npm i
cd/ client; npm i
  1. Create .env file, Enter these info:
MONGODB_URI=XXX
PORT=XXXX
SECRET=XXX

📶 Backend


  • Refer to API.md for more API documentation.
  • Using Session for Authentication

✍🏼 Wireframes




🎨 Visual




📖 User Stories


  1. The user should be able to log in and authenticate on the website, as well as create a user account. They should also be able to modify their account.

  2. The user should be able to filter and search for restaurants, and select food to order from them.

  3. The user should be able to checkout with their order, and leave reviews as needed.

  4. The user should be able to see their order history, as well as their past reviews.

  5. Unauthenticated users should be able to select the restaurants, but should not be able to check out.


🗒 Planning and Development Process


  • Frontend
  1. Completed a basic preproject exercise, including writing out the user stories.
  2. Drew wireframes by hand, and brainstormed over Figma.
  • Backend
  1. Design backend model Schemas, Create seed data
  2. Start by creating Basic CRUD, implement 'Search', 'Sort' data
  • Team Work
  1. Set up GitHub repository.
    • Main branch only for finalized dev work.
    • Additional branches are made for new features and changes
    • Once confirmed with the team, additional branches are merged into main.
  2. Set up Telegram group for group communication, and Discord for after-school pair programming.
  3. Deployed to Heroku to test.

Unsolved Problems / Major Hurdles


  • Custom Bootstrap CSS
  • Minor UI bugs
  • Authentication - plan to implement JWT instead of Session

APIs Used



Authors



Acknowledgments


About

Korean Food Delivery App - Group Project for General Assembly Software Engineering Immersive

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages