Git Product home page Git Product logo

code-challenge-levee-ruby's Introduction

Backend Engineer Code Challenge - Levee

Testing GitHub language count Repository size GitHub last commit License Stargazers

Status: WIP

About โ€ข Features โ€ข How it works โ€ข Tech Stack โ€ข Author โ€ข License

About

This project is a simple API for some Job routines, such as creating, listing, and activate.


Features

  • Create job
  • List the all jobs
  • Activate the status for a specific job
  • List the percentage and number of active jobs by category.
  • JWT Token Based Authentication
  • API versioning
  • JSON Schema implementation
  • Setup scripts

How it works

This project is Restful API:

  1. Backend

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: docker, docker compose, Git.

In addition, it is good to have an editor to work with the code like VSCode

Running the Backend (server)

# Clone this repository
$ git clone https://github.com/fabianoleittes/code-challenge-levee-ruby

# Access the project folder cmd/terminal
$ cd code-challenge-levee-ruby

# building the project
$ docker-compose build

# Run the application in development mode
$ docker-compose up

# The server will start at port: 3000 - go to http://localhost:3000

# Run tests in container
$ docker-compose run --rm api bin/rspec spec

API Request

Signup/Login

URL / ENDPOINT VERB DESCRIPTION
/v1/signup POST Create user
/v1/auth/login POST Generate token

Jobs

URL / ENDPOINT VERB DESCRIPTION
/v1/jobs POST Create Job
/v1/jobs GET Returns all Job
/v1/jobs/:id PUT Update Job Status
/v1/category/:id GET List percentage

Test endpoints API using Insomnia

Run in Insomnia


Tech Stack

The following tools were used in the construction of the project:

See more Gemfile

Utilities


Author


Fabiano Leite

Twitter Badge Linkedin Badge


License ๐Ÿ“

This project is under the license MIT.

Made with love by Fabiano Leite ๐Ÿ‘‹๐Ÿฝ Get in Touch!

code-challenge-levee-ruby's People

Contributors

fabianoleittes avatar

Stargazers

 avatar

Watchers

 avatar  avatar

code-challenge-levee-ruby's Issues

create job struct

  • create model
  • create controller
  • create routers
  • create request tests

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.