Giter VIP home page Giter VIP logo

taskmanagementapi's Introduction

Task Management API

Proposal: Task and user management API.

1) What was used?

Things to Remember:

You need Docker to run the project. Every time the project is taken down and restarted, all the PostgreSQL tables are dropped. This is only required for development environments.

2) Demo

2.1) Swagger API

Swagger API

2.2) To test the API, first you must use the Create New User endpoint, and set up your credentials:

Swagger API

2.3) Then you must use the sign-in endpoint, using your registered credentials, so you can get the access Token:

Swagger API

2.4) On the top of the screen, click the Authorize button and add your access token to Authorize any further requests:

Swagger API

3) Installation

3.1) Create a .env file in the root of the project for database access with the following:

DATABASE_URL="postgres://postgres:postgres@localhost:5432/task_management?schema=public"
JWT_SECRET="SUPERSEGREDOSECRETO"

3.2) In the root of the project, run "docker compose up" to start the docker containers.

docker compose up

3.3) To access the API documentation, run the project and access:

http://localhost:3000/api-docs

3.4) Back-end runs by default on:

http://localhost:3000/

3.5) There is a global '/api' decorator before every route.

taskmanagementapi's People

Contributors

matheusnugas 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.