https://github.com/adityassharma-ss/speer
Speer-Backend is a secure and scalable RESTful API that allows users to manage notes. It includes user authentication, note creation, updating, deletion, sharing, and searching functionality.
https://github.com/adityassharma-ss/speer
api expressjs mongodb nodejs rest-api
Last synced: 3 months ago
JSON representation
Speer-Backend is a secure and scalable RESTful API that allows users to manage notes. It includes user authentication, note creation, updating, deletion, sharing, and searching functionality.
- Host: GitHub
- URL: https://github.com/adityassharma-ss/speer
- Owner: adityassharma-ss
- Created: 2024-01-04T16:28:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T16:28:13.000Z (over 2 years ago)
- Last Synced: 2025-01-21T10:50:48.694Z (over 1 year ago)
- Topics: api, expressjs, mongodb, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Speer-Backend
Speer-Backend is a secure and scalable RESTful API that allows users to manage notes. It includes user authentication, note creation, updating, deletion, sharing, and searching functionality.
## Table of Contents
- [Overview](#overview)
- [Technical Stack](#technical-stack)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Run the Application](#run-the-application)
- [API Endpoints](#api-endpoints)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
## Overview
Speer-Backend provides a RESTful API for managing notes with features such as user authentication, note CRUD operations, sharing notes, and searching based on keywords.
## Technical Stack
The project is built using the following technologies:
- Node.js
- Express.js
- MongoDB
- Mongoose
- JWT for authentication
- Express Rate Limit for rate limiting
- ...
## Setup
### Prerequisites
List the prerequisites required to run your application, such as Node.js and MongoDB.
- Node.js
- MongoDB Cloud account
### Installation
Describe the installation steps. For example:
1. Clone the repository:
```bash
git clone https://github.com/your-username/your-project.git
```
2. Install the dependencies:
```
cd speer```
```bash
npm install
```
3. Set up the config file in terms of ".env" in the root folder:
```bash
PORT=3000
MONGODB_URI=mongodb://localhost:27017/speer
JWT_SECRET=your-secret
```
4. Run the application:
```bash
npm start
```
### API ENDPOINTS
List and briefly explain your API endpoints, including authentication requirements.
POST /api/auth/signup: Create a new user account.
POST /api/auth/login: Log in to an existing user account and receive an access token.
GET /api/notes: Get a list of all notes for the authenticated user.