Skip to content

Conscious is a second brain web app designed to save and search links, notes, and other media from various sources effortlessly. This repository contains the backend codebase for the Conscious application.

Notifications You must be signed in to change notification settings

KuldeepJha5176/conscious-backend

Repository files navigation

Conscious Backend

Logo

Conscious App

Conscious is a second brain web app designed to save and search links, notes, and other media from various sources effortlessly. This repository contains the backend codebase for the Conscious application.


Frontend Repository

👉 conscious-frontend


Getting Started

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/KuldeepJha5176/Concious-backend.git
cd Concious-backend
  1. Install dependencies with bun install
  2. Create a .env file in the root directory and add the following variables:
PINECONE_API_KEY=
GEMINI_API_KEY= 
JWT_SECRET = 
PORT=3000
MONGO_URL="mongodb+srv:
PINECONE_ENVIRONMENT=
PINECONE_INDEX=
YOUTUBE_API_KEY=
  1. Start the server with bun index.ts

Installation using Docker

  1. Clone the repository
    git clone https://github.com/KuldeepJha5176/Concious-backend.git
  2. Create a .env file in the root directory and add the following variables:
PINECONE_API_KEY=
GEMINI_API_KEY= 
JWT_SECRET = 
PORT=3000
MONGO_URL="mongodb+srv:
PINECONE_ENVIRONMENT=
PINECONE_INDEX=
YOUTUBE_API_KEY=
  1. Build the Docker image with docker build -t concious-backend .
  2. Run the Docker container with docker run -p 3000:3000 concious-backend

Usage

The application is built using the following technologies:

  • Bun: A fast all-in-one JavaScript runtime.
  • MongoDB: A NoSQL database.
  • Pinecone: A vector database for AI applications.
  • YouTube API: A powerful API for accessing YouTube data.

The application uses the following libraries:

  • Express.js: A popular web framework for Node.js.
  • Mongoose: A MongoDB ODM (Object Data Model) for Node.js.
  • JWT: A JSON Web Token (JWT) library for Node.js.
  • Axios: A popular HTTP client for Node.js.

Features

  • User authentication and authorization
  • User profile management
  • Link sharing and search
  • Note taking and search
  • Media upload and search
  • AI-powered search and recommendations
  • Integration with YouTube

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes and commit them with descriptive commit messages
  4. Push your changes to your forked repository
  5. Create a pull request to the main repository

License

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

About

Conscious is a second brain web app designed to save and search links, notes, and other media from various sources effortlessly. This repository contains the backend codebase for the Conscious application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published