Naytiv (A Food Delivery Web Application)

Introduction

Welcome to Naytif! Naytif is a food delivery web application that allows individuals within Nigeria to have access to indigenous cuisines from various restaurants. Naytif enables its users to place orders for their favorite menu items from the comfort of their homes.

Features

For Users:

User Authentication:

• Allow users to create accounts, log in, and log out securely.
• Implement authentication mechanisms such as email/password, OAuth, or social login.

Menu Browsing and Ordering:

• Display a variety of indigenous cuisines from various restaurants.
• Enable users to browse menus, view dish details, and add items to their cart.

Order Management:

• Provide users with the ability to view and manage their orders.

Payment Processing:

• The website only supports payment on delivery at this point in time.

For Restaurants:

Restaurant Registration:

• Allow restaurants to register accounts and manage their profiles.
• Enable restaurants to add, update, and remove menu items.

Order Management:

• Provide restaurants with tools to manage incoming orders.
• Allow restaurants to update order status and notify users about order preparation and delivery.

For Riders:

Rider Registration and Scheduling:

• Allow riders to register accounts and set their availability for delivery shifts.

Technologies Used

Frontend Frameworks and Libraries:

• React
• Tailwind CSS

Other Technologies:

• Vite (for build tooling)
• Figma (for design template)

Getting Started

Prerequisites

• Node.js (version >= 12.0.0)
• npm or yarn
• Git

Installation

• Clone the repository: git clone https://github.com/khairatAA/Naytif.git

• Navigate to the frontend directory: cd Naytif/frontend

• Install dependencies: npm install

• Navigate to the backend directory: cd Naytif/frontend

• Install dependencies: pip install -r requirements.txt

Running the Application

• Start the development server: npm start

• Access the application at http://localhost:3000 by default.

Design Stage

Before the coding process, a design template was created using Figma to visualize our vision for our food delivery application. You can view the design template here.

Usage

Basic Usage Instructions

• Navigate through the application using the navigation bar at the top.

• Explore different sections, such as browsing menus, placing orders, and tracking deliveries.

Contributing

Please read the Contributing instructions

License

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

Contributors

• Khairat Adesina khairatadesina01@gmail.com LinkedIn X

• Omar Jammeh Orms45@gmail.com LinkedIn X