Notes Server

Notes Server is a REST API built with Express.js and MongoDB using TypeScript. Checkout the client.

Table of contents

• Installation
• Features
• Dependencies
• Documentation
• Running Tests
• Contributing

Installation

git clone https://github.com/iberatkaya/notes-server.git
npm install
npm run dev

Features

• Create an account.
• Create, edit, and fetch notes.

Dependencies

• express - The Node.js server for handling REST API requests.
• mongoose - The MongoDB object modelling package.
• passport - Used for user authentication.
• tsoa - Used for documentation generation.
• express-validator - Used for verification.
• nodemailer - Used for sending verification emails.
• ts-jest & jest - Used for testing with TypeScript.
• supertest - Used for API request testing.
• typescript-eslint & eslint - Used for linting.

Documentation

You can view the API documentation here.

Running Tests

npm test

Contributing

Contributions, issues and feature requests are welcome! Feel free to check issues page.