OlvArthur / bossabox

Welcome to VUTTR 👋

Useful API to allow users to create and manage tons of tools

API Blueprint

The API documentation in included in the docs folder.

Install

First you need to have nodejs installed in your machine. For that you can use nvm

This project used a Postgres database running on a docker container. After Docker installation, run

docker run --name [database name] -e POSTGRES_PASSWORD=[database password] -p 5432:5432 -d postgres 

Using a IDE to manage Postgres such as Postbird, create a database named bossabox. Keep in mind if you want to change the database name, you have to edit the file database.js

Clone the repositorie to your workspace

Run

yarn 

in the root of the repositorie

To use the migrations in your project, run

yarn sequelize db:migrate

If it works, two new tables ( users and tools) will be in your database. If only one table comes up, try running again. In case of errors, try reinstalling the sequelize with

yarn add sequelize sequelize-cli

In order to make request to the API, install insomnia and import the insomnia file inside the docs folder in your repositorie.

To initiate the server, run

yarn dev

or

yarn node-sucrase src/server.js

Author

👤 Arthur Oliveira

• Github: @OlvArthur

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator