Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kamal9494/codebugged-task

full-stack task
https://github.com/kamal9494/codebugged-task

expressjs face-api-js mongodb nodejs reactjs

Last synced: 7 days ago
JSON representation

full-stack task

Awesome Lists containing this project

README

        

# Full-Stack Task

## Tech Stack
- **Frontend:** React.js with TailwindCSS and React-Router DOM v6 for routing.
- **Backend:** Express.js
- **Database:** MongoDB
- **External Service:** face-api.js

## Demo URL

Frontend: [https://codebugged-task.vercel.app/](https://codebugged-task.vercel.app/)

Backend: [https://codebugged-server.vercel.app](https://codebugged-server.vercel.app)

## Features Overview

- Created following pages as mentioned in task description :
1. `/` to display user information and pictures.
2. `/login` where user can login using username and their picture.
3. `/register` to register their face.


- **API Endpoints:** Developed API endpoints using Express.js
- `/api/users` POST Method for user registration storing user info in database.
- `/api/auth` POST Method to authenticate user.
- `/images` GET, POST Method for getting and uploading images.


- Created a responsive design to ensure compatibility across various devices.
- Both frontend and backend is deployed in vercel.

## Setup
Clone the project
```bash
git clone https://github.com/kamal9494/codebugged-task
```

Navigate to client to run frontend
```bash
cd client
npm install
npm run dev
```

Navigate to server to run backend
```bash
cd server
npm install
npm run dev
```

## Architecture Diagram
![image](https://github.com/kamal9494/codebugged-task/assets/97849725/99c666cb-1509-4a3f-869d-723bfe990932)