Skip to content

kjkGustavo/transactions

Repository files navigation


Transactions App

Página inicial da aplicação

Upload transactions to App
Challenge · Roadmap

About The Project

An application that allows the upload of transactions file of products sold to normalize the data and store them in a relational database. Some features:

  • Details of the products
  • Details of the transactions
  • Analytics

Use the file sales.txt to upload.

Built With

Documentations

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Production

Prerequisites

  • Docker
  • docker-compose
  1. Copy .env.example to .env and configure if necessary.
  2. Run docker-compose up -d
  3. Running on localhost:80

Admin account:

  • Username: admin
  • Password: admin@123

Development

Prerequisites

  1. Copy .env.example to .env.
  2. yarn or npm install
  3. yarn prisma generate
  4. yarn prisma migrate deploy
  5. yarn prisma db seed (create admin account)
  6. Running... ✨

Admin account:

  • Username: admin
  • Password: admin@123

Test

  1. Check .env.test and configure if necessary.
  2. yarn test:docker
  3. Running... ✨

Roadmap

  1. Make a screen (by forms) to upload the file
  2. Make the parsing of the received file, normalize the data and store them in a relational database, following the file interpretation settings
  3. Show a list of product transactions imported by producer/affiliate, with a totalizer of the value of the transactions carried out
  4. Treat the backend errors, and report messages of friendly erros in frontend.

More details and stages of the roadmap can be accessed at ROADMAP.md

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Gustavo Lima - @kjkGustavo - [email protected]

Project Link: https://github.com/kjkGustavo/transactions