/hammer-backend

⚒ Hammer API

Primary LanguageTypeScriptMIT LicenseMIT


About    |    Techs    |    Prerequisites   |    How to run    |    Front-end    |    Builders


⚒️ About

Hammer is a consistent app aimed at whoever want to manage your infrastructure optimally, flexibly, agile and above all simple.

In this way, registered customers can create images, delete them individually and in their entirety, create containers based on the images you can download them, run, pause, restart and much more.

⚒️ Techs

⚒️ Prerequisites

🔨 Environment variables

For the application to work correctly it is necessary to include some environment variables in a file dedicated to this purpose.

The file must be called .env and you basically must enter the following variables.

PORT=
HOSTNAME=
DOCKER_URL=
MONGO_USERNAME=
MONGO_PASSWORD=
MONGO_HOST=

To make the process easier you can just delete the .example in the .env.example file and use your infrastructure information.

🔨 Dependencies

To install the dependencies your should user the comand. an:

npm install
# or
yarn install

⚒️ How to run

🔨 Development

Start development server with the following command:

npm run dev
# or
yarn run dev

🔨 Production

In progress... 🚧

⚒️ Endpoints

Fork the postman workspace to your account, download it and change according your host.

Run in Postman

⚒️ Builders

Leonardo Morais   |    Lucas Polizeli   |    Thales Pereira   |    Victor Barreto


Have a Hammer experience.

Visits Badge Last update Repo size