{"id":15857222,"url":"https://github.com/eimaam/anon-notes-api","last_synced_at":"2026-01-04T07:52:24.083Z","repository":{"id":248933063,"uuid":"830197925","full_name":"eimaam/anon-notes-api","owner":"eimaam","description":"API for anon-notes App - Fun! A WebApp for creating and sharing anonymous notes/messages with Friends/Family or the Public","archived":false,"fork":false,"pushed_at":"2024-07-18T21:18:40.000Z","size":181,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-01-26T03:02:07.086Z","etag":null,"topics":["anon","anonymous-message","encrypt"],"latest_commit_sha":null,"homepage":"https://anon-notes-api.vercel.app","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/eimaam.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}},"created_at":"2024-07-17T19:43:38.000Z","updated_at":"2024-07-18T21:18:43.000Z","dependencies_parsed_at":"2024-07-23T20:34:49.195Z","dependency_job_id":null,"html_url":"https://github.com/eimaam/anon-notes-api","commit_stats":null,"previous_names":["eimaam/anon-notes-api"],"tags_count":0,"template":false,"template_full_name":"eimaam/nodejs-express-vercel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fanon-notes-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fanon-notes-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fanon-notes-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fanon-notes-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eimaam","download_url":"https://codeload.github.com/eimaam/anon-notes-api/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244745751,"owners_count":20503050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["anon","anonymous-message","encrypt"],"created_at":"2024-10-05T20:21:24.290Z","updated_at":"2026-01-04T07:52:24.043Z","avatar_url":"https://github.com/eimaam.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Anon-notes: Anonymous Notes - Backend\n\nThis repository contains the backend code for the Anonymous Messaging App `anon-notes`, a web application that allows users to create threads with titles and receive anonymous replies.\n\n## Table of Contents\n\n- [Features](#features)\n- [Tech Stack](#tech-stack)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n  - [Environment Variables](#environment-variables)\n  - [Running the Application](#running-the-application)\n\n## Features\n\n- User registration and authentication\n- Create threads with titles\n- Receive anonymous messages for threads \u003e Responses\n- Favourite and Archive Replies\n- Share Replies to Socials as image or plain text.\n- Light and Dark mode support for the UI (handled in the frontend)\n- Notifications via Firebase\n\n## Tech Stack\n\n- **Backend**: Node.js, Express.js\n- **Database**: MongoDB\n- **Authentication**: JSON Web Tokens (JWT)\n- **Notifications**: Firebase\n- **Validation**: express-validator\n- **Programming Language**: TypeScript\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js (v20 or later)\n- npm or yarn\n- MongoDB (local or cloud instance)\n- Firebase project (not necessary)\n\n### Installation\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone [https://github.com/your-username/anonymous-messaging-backend.git](https://github.com/eimaam/anon-notes-api.git)\n   cd anon-notes-api\n   ```\n\n2. **Install dependencies:**\n\n   ```bash\n   npm install\n   ```\n\n   or\n\n   ```bash\n   yarn install\n   ```\n\n### Environment Variables\n\nCreate a `.env` file in the root directory and add the env as listed in `.env.example` file\n\n### Running the Application\n\nStart the development server:\n\n```bash\nnpm run dev\n```\n\nor\n\n```bash\nyarn dev\n```\n\nThe server will start on `http://localhost:3000` (Here the PORT you served via `env).\n\n### Example JSON Responses\n\n#### Register\n\n```json\n{\n  \"success\": true,\n  \"message\": \"User registered successfully\",\n  \"data\": {\n    \"id\": \"60d21b4667d0d8992e610c85\",\n    \"username\": \"john_doe\",\n    \"email\": \"john@example.com\"\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feimaam%2Fanon-notes-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feimaam%2Fanon-notes-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feimaam%2Fanon-notes-api/lists"}