UNSAVEBOX API

Description

A digital safe deposit box that lets users add items and keep them safe from peepers.

APPS

Auth Resource

Safebox Resource

APIs

• User signup
• Create a safebox
• Add content to a safebox
• Get the contents in a safebox

Tech Stacks

• Language -> Javascript (Node.js)
• Backend Framework -> Express
• Database -> Mongodb
• ORM - > Mongoose

Setup & Installation

• Clone the project
• cd into the project directory
• Install the packages using npm or yarn

$ npm install

Environment Setup

Create '.env' file in the root directory and use the '.env.sample' file to configure the necessary configurations or use the defaults.

Running the app

$ npm run start

# watch mode
$ npm run dev

Test

# e2e tests
$ npm run test

Swagger API

Checkout the API @ the url below.
APP_PORT is default to 3000 or change it to whatever you set in the .env file.

http://localhost:3000/api/doc

Stay in touch

• contact me @ adeyeyetimothy33@gmail.com