Skip to content

Blink Bite is a grocery delivery web application designed to simplify and speed up the shopping experience. The platform allows users to browse, select, and purchase grocery items from a wide range of categories, all delivered to their doorstep with just a few clicks.

Notifications You must be signed in to change notification settings

iaavas/blink-bite

Repository files navigation

Blink Bite

Blink Bite is a grocery delivery web application designed to simplify and speed up the shopping experience. The platform allows users to browse, select, and purchase grocery items from a wide range of categories, all delivered to their doorstep with just a few clicks. The application is built to provide a seamless user experience with an intuitive interface, efficient search options, and real-time order tracking.


Table of Contents

  1. Project Overview
  2. Tech Stack
  3. Installation
  4. Scripts
  5. Usage
  6. Development
  7. Building and Deployment
  8. Contributing
  9. License

Project Overview

Blink Bite is built with [core technologies you're using]. It aims to provide [main goal or feature of your project].

Key Features:

  • User-Friendly Interface: Easy navigation for browsing through various grocery categories.
  • Fast Search: Find grocery items quickly with a powerful search feature.
  • Admin Managent: An admin panel for CRUD operations of groceries.

Tech Stack

  • Frontend: Next.js
  • Backend: Express
  • Database: MongoDB

Installation

To set up the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/iaavas/blink-bite.git
    cd blink-bite
  2. Install dependencies:

    For the frontend:

    npm install

    For the backend (if separate):

    npm install

Scripts

The project includes the following scripts to streamline your workflow:

Frontend Scripts

  • dev: Start the Next.js development server

    npm run dev
  • build: Build the application for production

    npm run build
  • start: Start the Next.js production server

    npm run start
  • lint: Run the linter to check for code issues

    npm run lint

Backend Scripts

  • dev:server: Start the development server for the API using nodemon and ts-node
    npm run dev:server

Usage

After installing dependencies and running the development server, you can access the application at http://localhost:3000 for the frontend and http://localhost:PORT for the backend.


Development

To work on the development environment:

  1. For the frontend, run:

    npm run dev

    This starts the Next.js development server, with hot reloading enabled.

  2. For the backend, run:

    npm run dev:server

    This starts the backend API server with nodemon, so any changes will automatically reload the server.


Building and Deployment

To build the application for production:

npm run build

Once the build is complete, you can start the production server with:

npm run start

For deployment, follow the relevant platform documentation (e.g., Vercel for Next.js).


Contributing

We welcome contributions to Blink Bite. Please follow these steps to contribute:

  1. Fork the repository.
  2. Clone your fork:
    git clone https://github.com/your-username/blink-bite.git
  3. Create a new branch:
    git checkout -b feature-name
  4. Make your changes and commit them:
    git commit -m "Description of your changes"
  5. Push to your fork:
    git push origin feature-name
  6. Open a Pull Request.

Please make sure your code follows the project’s style guide and passes the linting tests before submitting.


License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Blink Bite is a grocery delivery web application designed to simplify and speed up the shopping experience. The platform allows users to browse, select, and purchase grocery items from a wide range of categories, all delivered to their doorstep with just a few clicks.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published