Code Monkey home page Code Monkey logo

company-sales-backend's Introduction

rspec rubocop simplecov brakeman bundler_audit reek ruby_critic

SalesBox

SalesBox is a easy to use cloud based sales analyzer that accepts text files (tab separated) uploads.

https://sales-box-app.vercel.app/

Features

With SalesBox you can:

  • Check the Gross Income for each upload
  • Check the All Time Gross Income for all the uploads made
  • See a list of uploaded files to control your analysis.

Get Started ๐Ÿ”ฅ

This repository is the Rails back-end for the SalesBox project. Follow the setup below to install and run it locally.

Prerequisites ๐Ÿ’พ

To run the project, you will need the following dependencies installed:

Ruby 2.7.2

Gem bundler

Postgresql

Installation ๐Ÿ› 

  1. After clonning the repository, in the ROOT directory run the following command to install the dependencies.

     bundle install
    

Running the project โš™๏ธ

To run the project locally, use the commands bellow.

  1. Starts the ProstgreSQL service.

Linux:

    sudo service postgresql start

MacOS:

    brew service postgresql start
  1. Create and prepare the database.

     bin/rails db:create
     bin/rails db:migrate
    
  2. Run the Rails server.

     bin/rails server
    

The Rails server will run by default on localhost:3000.

Running Tests โœ…

  1. Run tests with

     bundle exec rspec
    
  2. For reporting access coverage/index.html on your browser.

Improvements ๐Ÿ“ˆ

  1. Use ActiveStorage with some service like AWS for work with the company sales uploaded file.
  2. Cache on total all-time gross income endpoint.
  3. Some code refactoring to enable the disabled RuboCop cops and Reek rules.

company-sales-backend's People

Contributors

matheuspolicamilo avatar

Stargazers

 avatar

Watchers

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