Code Monkey home page Code Monkey logo

toolz-api's Introduction

Toolz API 🧰


About

Need suggestions for which tools to use in your projects? Use Toolz! In this RestApi you can see the tools listed that can be useful in your project. Also, if you are authenticated, you can post and delete tools. Feel free to use and contribute!


Technologies

Tools that were used in the project:

For more see the package.json


Documentation

Getting Started

- Prerequisites

Docker

  • ubuntu
sudo apt-get update
sudo apt-get install apt-transport-https ca-certificates curl gnupg lsb-release
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io

  • fedora
sudo dnf -y install dnf-plugins-core
sudo dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo
sudo dnf install docker-ce docker-ce-cli containerd.io

Docker compose

  • ubuntu
sudo curl -L "https://github.com/docker/compose/releases/download/1.26.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

  • fedora
sudo dnf install docker-compose

  • windows
already installed with the docker package

How to run

  1. Clone the repo and access it
git clone https://github.com/cgabrieu/toolz-api.git && cd toolz-api
  1. Rename the .env.example to .env, .env.dev.example to .env.dev and .env.test.example to .env.test and fill in all of them

  2. Create the volume, image and run the container

sudo docker-compose up -d
  1. Run the database migration
sudo docker exec -it toolz-api_app_1 sh -c "npm run migration:run"
  1. To see the logs outputs enter in the app with
sudo docker-compose up
  1. To Test: As there is no test database on container, be aware that all data will be erased when run the command
sudo docker exec -it toolz-api_app_1 sh -c "npm run test:watch"

How to contribute

  1. Fork the project.
  2. Create a new branch with your changes: git checkout -b feat/myFeatureName
  3. For each feature implemented, make a commit specifying what was done
  4. Submit your changes: git push -u origin feat/myFeatureName

Developer

toolz-api's People

Contributors

cgabrieu avatar

Stargazers

Yuri Pereira avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.