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!
Tools that were used in the project:
For more see the package.json
- 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
- windows - Look here
- 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
- Clone the repo and access it
git clone https://github.com/cgabrieu/toolz-api.git && cd toolz-api
-
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
-
Create the volume, image and run the container
sudo docker-compose up -d
- Run the database migration
sudo docker exec -it toolz-api_app_1 sh -c "npm run migration:run"
- To see the logs outputs enter in the app with
sudo docker-compose up
- 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"
- Fork the project.
- Create a new branch with your changes:
git checkout -b feat/myFeatureName
- For each feature implemented, make a commit specifying what was done
- Submit your changes:
git push -u origin feat/myFeatureName