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.
- Project Overview
- Tech Stack
- Installation
- Scripts
- Usage
- Development
- Building and Deployment
- Contributing
- License
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.
- Frontend: Next.js
- Backend: Express
- Database: MongoDB
To set up the project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/iaavas/blink-bite.git cd blink-bite
-
Install dependencies:
For the frontend:
npm install
For the backend (if separate):
npm install
The project includes the following scripts to streamline your workflow:
-
dev
: Start the Next.js development servernpm run dev
-
build
: Build the application for productionnpm run build
-
start
: Start the Next.js production servernpm run start
-
lint
: Run the linter to check for code issuesnpm run lint
dev:server
: Start the development server for the API usingnodemon
andts-node
npm run dev:server
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.
To work on the development environment:
-
For the frontend, run:
npm run dev
This starts the Next.js development server, with hot reloading enabled.
-
For the backend, run:
npm run dev:server
This starts the backend API server with
nodemon
, so any changes will automatically reload the server.
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).
We welcome contributions to Blink Bite. Please follow these steps to contribute:
- Fork the repository.
- Clone your fork:
git clone https://github.com/your-username/blink-bite.git
- Create a new branch:
git checkout -b feature-name
- Make your changes and commit them:
git commit -m "Description of your changes"
- Push to your fork:
git push origin feature-name
- Open a Pull Request.
Please make sure your code follows the project’s style guide and passes the linting tests before submitting.
This project is licensed under the MIT License - see the LICENSE file for details.