Skip to content

An image background removal app and a demo design editor built using Nextjs, CreativeEditor SDK Engine, and Clerk.

License

Notifications You must be signed in to change notification settings

BolajiAyodeji/attraktives-headshot

Repository files navigation

A web application that enables users to remove the background of an image and craft attractive profile pictures for social media platforms + other image editor demos.


Tip

Kindly read this comprehensive tutorial to learn how to build editing apps using IMGLY’s CE.SDK Engine.


Table of Contents


Apps

There are three apps in this project, namely:

  1. Remove Image Background (/bg-remove): can be accessed with this live link (doesn't require a license).
  2. Add Image Background Color (/bg-add): can be tested only in development using the demo license.
  3. General Design Editor (/editor): can be tested only in development using the demo license.

Features and Todos

  • Remove the background from an image (try it live).
  • The above uses the ONNX model and WASM files hosted by IMG.LY.
  • Add background color options to a transparent image.
  • Create and edit designs with a Canva-like editor.
  • Authentication and protected pages.
  • Show download progress (background removal).
  • Add background-removal plugin to the editor.

Important Files and Folders

Path Description
.env.example Example file with all the required environment variables.
/app/auth /auth/sign-in and auth/sign-up authentication pages.
/app/bg-add/page.tsx Page for the background removal app.
/app/bg-remove/page.tsx Page for the background color add app.
/app/editor/page.tsx Page for the general design editor app.
/app/start/page.tsx Page for the start page (select app).
/app/components/editorCanvas.tsx React component for the /editor page.
/app/components/headshotCanvas.tsx React component for the /bg-add page.
/app/layout.tsx Shared UI for fonts and metadata configuration.
/app/page.tsx Home page (/).
/utils/grid.ts Utility file for the grid layout options.
middleware.ts Handle protected pages before processing all requests.

Getting Started

To run this application locally, kindly follow the steps below:

  1. Rename the .env.example file to .env.local and fill in the required environment variables (leave the pre-filled ones as they are).

    • NEXT_PUBLIC_CESDK_LICENSE: IMG.LY CE.SDK license (sign up for one or get a demo here).
    • NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: Clerk publishable API key (sign up and copy this from the dashboard).
    • CLERK_SECRET_KEY: Clerk secret API key (sign up and copy this from the dashboard).
  2. Install all required dependencies with the npm install command (or use yarn / pnpm).

  3. Run the development server with the npm run dev command.

  4. Open http://localhost:3000 with your browser to see the result.

  5. All good! You can start modifying any page and the app will auto-update.

Repo Stats Summary

GitHub Repository Statistics

Contributors Guide

  1. Fork this repository (learn how to do this here).

  2. Clone the forked repository like so:

git clone https://github.com/<your username>/attraktives-headshot.git && cd attraktives-headshot
  1. Make your changes and create a pull request (learn how to do this).

  2. I'll attend to your pull request soon and provide some feedback.

License

This repository is published under the MIT license.


About

An image background removal app and a demo design editor built using Nextjs, CreativeEditor SDK Engine, and Clerk.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published