Skip to content

A MVP of monolithic kind with an app that recognices objects and make different actions on the client

Notifications You must be signed in to change notification settings

jhderojasUVa/Life_BSO

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Life BSO

Body, Soul, and Mind

This project is a web application that uses your camera to recognize objects and plays different music based on the recognized object. It's designed to create a personalized atmosphere based on your environment.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Docker and Docker Compose
  • Python 3.9+ and Poetry
  • Node.js and npm

Installation

  1. Clone the repo:

    git clone https://github.com/your_username/Life_BSO.git
    cd Life_BSO
  2. Install dependencies: This project uses a Makefile to simplify the installation process. The following command will install both the frontend and backend dependencies:

    make install

Development

This project is set up as a monorepo with a frontend and a backend. You can run the application using Docker or manually using the root Makefile.

Using Docker

To run the application using Docker, you will need to have Docker and Docker Compose installed.

  • make docker-up: Build and run the containers.
  • make docker-down: Stop and remove the containers.

Running Manually

  • make run: Run both the frontend and the backend development servers.
  • make lint: Lint both the frontend and the backend.
  • make clean: Clean the backend build artifacts.

Backend

For more information about the backend, see the backend README.

Frontend

For more information about the frontend, see the frontend README.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

About

A MVP of monolithic kind with an app that recognices objects and make different actions on the client

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published