{"id":24432090,"url":"https://github.com/smartcraze/second-brain-backends","last_synced_at":"2026-03-01T22:36:11.933Z","repository":{"id":271256341,"uuid":"912870321","full_name":"smartcraze/Second-brain-Backends","owner":"smartcraze","description":"Second brain Backend Node js Typescipt","archived":false,"fork":false,"pushed_at":"2025-04-25T09:29:42.000Z","size":42,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-26T23:21:07.130Z","etag":null,"topics":["backends","brainly","typescipt"],"latest_commit_sha":null,"homepage":"https://brainlyapi.surajv.me","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartcraze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-06T15:05:45.000Z","updated_at":"2025-04-25T09:29:45.000Z","dependencies_parsed_at":"2025-10-17T02:44:36.997Z","dependency_job_id":"bc720f9f-6387-4fbb-96db-8b8d0e4770d0","html_url":"https://github.com/smartcraze/Second-brain-Backends","commit_stats":null,"previous_names":["smartcraze/second-brain-backends"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/smartcraze/Second-brain-Backends","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcraze%2FSecond-brain-Backends","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcraze%2FSecond-brain-Backends/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcraze%2FSecond-brain-Backends/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcraze%2FSecond-brain-Backends/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartcraze","download_url":"https://codeload.github.com/smartcraze/Second-brain-Backends/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcraze%2FSecond-brain-Backends/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29987145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T21:06:37.093Z","status":"ssl_error","status_checked_at":"2026-03-01T21:05:45.052Z","response_time":124,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backends","brainly","typescipt"],"created_at":"2025-01-20T15:32:26.458Z","updated_at":"2026-03-01T22:36:11.915Z","avatar_url":"https://github.com/smartcraze.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brainly Backend API\n\nWelcome to the official documentation and source code for the **Brainly Backend API**. This API powers the Brainly platform, providing functionality to manage users, content, and brain-related data.\n\n## Table of Contents\n\n- [About the Project](#about-the-project)\n- [Features](#features)\n- [API Endpoints](#api-endpoints)\n  - [User Routes](#user-routes)\n  - [Contents Routes](#contents-routes)\n  - [Brain Routes](#brain-routes)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Technologies Used](#technologies-used)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## About the Project\n\nThe Brainly Backend API is designed to handle user management, content creation and management, and brain-related operations (which may include content recommendations, sharing, etc.). This API is part of the Brainly platform, which provides educational tools for users.\n\n## Features\n\n- User Authentication and Management\n  - Registration\n  - Login\n  - Profile management\n- Content Management\n  - Create, update, retrieve, and delete content\n- Brain Operations\n  - Shareable content and data interactions\n\n## API Endpoints\n\n### User Routes\n\n- **`GET /api/v1/user`**\n  - Description: Get details of the authenticated user.\n  \n- **`POST /api/v1/user/signup`**\n  - Description: Register a new user.\n  - Body: \n    ```json\n    {\n      \"email\": \"user@example.com\",\n      \"password\": \"your_password\"\n    }\n    ```\n\n- **`POST /api/v1/user/signin`**\n  - Description: User login.\n  - Body:\n    ```json\n    {\n      \"email\": \"user@example.com\",\n      \"password\": \"your_password\"\n    }\n    ```\n\n### Contents Routes\n\n- **`GET /api/v1/contents`**\n  - Description: Retrieve all content.\n\n- **`POST /api/v1/contents`**\n  - Description: Create new content.\n  - Body:\n    ```json\n    {\n      \"title\": \"Sample Content\",\n      \"description\": \"Content description here\"\n    }\n    ```\n\n- **`PUT /api/v1/contents/:id`**\n  - Description: Update existing content by ID.\n  - Parameters:\n    - `id`: Content ID\n  - Body:\n    ```json\n    {\n      \"title\": \"Updated Content Title\",\n      \"description\": \"Updated description\"\n    }\n    ```\n\n- **`DELETE /api/v1/contents/:id`**\n  - Description: Delete content by ID.\n  - Parameters:\n    - `id`: Content ID\n\n### Brain Routes\n\n- **`GET /api/v1/brain/share`**\n  - Description: Get brain-related data.\n  \n- **`POST /api/v1/brain/:shareLink`**\n  - Description: Share a specific brain-related link.\n  - Parameters:\n    - `shareLink`: A shareable link (for example, a content link).\n\n## Installation\n\nTo run this project locally, follow the steps below:\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/yourusername/brainly-backend-api.git\n   cd brainly-backend-api\n   ```\n\n2. Install dependencies:\n   ```bash\n   npm install\n   ```\n\n3. Set up environment variables:\n   - Create a `.env` file in the root of the project and configure the necessary variables, such as:\n     ```\n     PORT=3000\n     MONGODB_URI=mongodb://localhost:27017/brainly\n     JWT_SECRET=your_secret_key\n     ```\n\n4. Run the server:\n   ```bash\n   npm run dev\n   ```\n\n5. Open the application in your browser:\n   - Visit `http://localhost:3000` to start interacting with the API.\n\n## Usage\n\nThe API provides endpoints that handle user management, content creation, and brain-related functionality. You can interact with the endpoints through HTTP requests using tools like Postman, curl, or directly in your application.\n\n## Technologies Used\n\n- **Node.js**: Backend runtime environment.\n- **Express.js**: Web framework for building REST APIs.\n- **MongoDB**: NoSQL database for storing user and content data.\n- **Mongoose**: ODM (Object Document Mapper) for MongoDB.\n- **JWT (JSON Web Token)**: For user authentication and authorization.\n- **TypeScript**: JavaScript superset for building scalable and maintainable applications.\n\n## Contributing\n\nIf you'd like to contribute to this project, follow these steps:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-name`).\n3. Commit your changes (`git commit -am 'Add new feature'`).\n4. Push to the branch (`git push origin feature-name`).\n5. Open a pull request.\n\n\n## Contact\n\n- **Suraj Vishwakarma**  \n  Visit my portfolio: [https://www.surajv.me](https://www.surajv.me)  \n  Email: [your.email@example.com](mailto:your.email@example.com)\n\n---\n\nThank you for using the Brainly Backend API! Happy coding! 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartcraze%2Fsecond-brain-backends","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartcraze%2Fsecond-brain-backends","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartcraze%2Fsecond-brain-backends/lists"}