Giter Club home page Giter Club logo

hlocal-api's Introduction

About

NodeJS API for a companies/locations management system. The user can create companies, attach responsibles and locations to it. Locations also can have responsibles specified.

The user only has access to companies created by himself.

How can I use the API?

This api is deployed on a Digital Ocean server. You can easily check the documentation and test it by accessing:

https://api.hlocal.leonardoribeiro.com/swagger

How can I run it locally?

If you prefer to run it locally on your machine, follow the steps:

  1. Clone this repository.

  2. Create your .env at the root of the project file based on the .env.example.

  3. Install the dependencies:

npm install
  1. Start the containers (they must be already running before next step):
docker-compose up
  1. Run database migrations with:
npm run docker:db-run-migrations

Where is the app frontend?

You can check out the frontend repository at:

https://github.com/leonardorib/hlocal-app

The author

Made with โค๏ธ by Leonardo Ribeiro. ๐Ÿ‡ง๐Ÿ‡ท

Get in touch! ๐Ÿ˜ƒ

LinkedIn
ย ย 
Email

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.