Yandex Test Todo API

A simple API for a todo application.

📝 Table of Contents

• About
• Docs
• Getting Started
• Available NPM commands
• Usage
• Version 2.0.0 changes
• Built Using
• Authors

🧐 About

The purpose of this project is pretty obscure but out team is all in.

🧾 Docs

You can view the documentation for this project at /api-docs route (e.g. http://localhost:8080/api-docs | after running the scripts below)

🏁 Getting Started

Prerequisites

You need to install nodejs and npm before using the API.
Then:

Clone the repo:

git clone https://gitlab.mmtr.ru/alobovskiy/yandex-test-todo.git

CD into the project directory:

cd yandex-test-todo

Install all dependencies:

npm install

Run local development server:

npm start

🔧 Available NPM commands

Run local development server

npm run start

Fill the database with mock data

npm run smallInsert

Fill the database with more mock data

npm run bigInsert

Clear the database

npm run clear

🎈 Usage

For available routes check /api-docs page where docs for the API are held.

❕ Version 2.0.0 changes

Later all responses contained one data property. Now we omit it and pass all the data directly in response body (check the docs bruh).

We've changed names of controllers' methods.

For listController:

allDelete -> deleteAll

For cardController:

allDelete -> deleteAll

allComplete -> toggleCompleteAll

NEW method also has been added.

For cardController:

deleteComplete

For additional information about all the methods please check the docs bruh.

⛏️ Built Using

• SQLite - Database
• Sequelize - ORM
• Express - Server Framework
• NodeJs - Server Environment

✍️ Authors

• @alobovskiy - Superior front-end developer
• @abiryulin - Superior front-end developer
• @iklimov - Superior front-end developer
• @mnepritimov - Supervisor
• @atupikova - Supervisor

See also the list of contributors who participated in this project.