OscuroBok Backend Codebase

Welcome to the OscuroBok Backend Codebase! This README provides a comprehensive yet simple guide for new contributors to understand the key components and flow of this project. The codebase primarily focuses on user

Authentication,
OTP verification,
Role-based access

Tech Stack

OscuroBok-Tech Stack

Frontend: Next.js, React, Redux
Styling: Material-UI (MUI) components, custom styles
API Requests: Axios (via services)
State Management: Redux Toolkit
Form Handling: Formik & Yup (for validation)
Authentication: OTP-based (Simulated)

Role-Based Routing

Based on the user type (Admin/User), redirection occurs after login using a single API call.

Workflow Diagram

graph TD
    A[OTP Form Displayed] --> B[User Enters OTP]
    B --> C{OTP Valid?}
    C -->|Yes| D[Proceed to Reset Password]
    C -->|No| E[Error: Invalid OTP]

Project Flow

graph TD
    User --> |Submits Email| AuthPage
    AuthPage --> |Sends Email| Backend
    Backend --> |OTP Sent| AuthPage
    User --> |Submits OTP| AuthPage
    AuthPage --> |Verifies OTP| Backend
    Backend --> |OTP Valid| AuthPage
    AuthPage --> |Redirect to Reset Password| User

To clone a code from a particular branch, use:

git clone -b branch_name https://github.com/OscuroBok/OscuroBok_dashboard_FE.git
To clone a code from a branch, use:
git clone https://github.com/OscuroBok/OscuroBok_dashboard_FE.git

Commands used:

npm install (This installs all required dependencies listed in the package.json.)
npm run prisma:update (Updates Prisma and generates the latest schema.)
npm run seed:role (Inserts roles into the database. Run this if you don't see the message: "The seed command has been executed.")
npm run seed:user (Inserts user details into the database.)
npm run seed:restaurant (Inserts restaurant details into the database.)
npm run seed:admin (Inserts admin details into the database.)
npm run seed:all (Inserts user, restaurant and admin details into the database.)
npm start (Starts the application.)

Database Migration

npm run db:migrate_all: Migrates all schemas and creates necessary tables in the database.

Note: This command should be used by backend developers or those managing the database. It is not intended for frontend developers.

OscuroBok / OscuroBok_dashboard_BE

readme