Skip to content

Latest commit

 

History

History
210 lines (157 loc) · 5.69 KB

README.md

File metadata and controls

210 lines (157 loc) · 5.69 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Reseller Cashback API

A simple API with resellers, orders, and cashbacks endpoints.

View Examples · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

Project screenshot

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This are the preqrequisites you need to install to run this project.

If you want to run this project with Docker, you will need:

Installation

  1. Clone the repo

    git clone https://github.com/mgiovani/reseller-cashback-api.git

  2. (Optional) Import the Insomnia file at docs/reseller-cashback-insomnia.json to get all requests configured.

  3. Running locally:

    1. Install dependencies 
      make install
    2. Edit envvars inside the .env file 
      vim .env
    3. Load the .env file 
      source .env
    4. Migrate database 
      make migrate
    5. Create superuser 
      make create-superuser
    6. Run the code 
      make run
    7. Get your superuser JWT token at /login/

  4. Running with Docker:

    1. Copy env.example 
      cp env.example .env
    2. Edit credentials inside the .env file 
      vim .env
    3. Load the .env file 
      source .env
    4. Create superuser 
      make create-docker-superuser
    5. Run the code 
      make run-docker-mode
    6. Get your superuser JWT token at /login/

Usage

Check some examples of the project:

Reseller list endpoint:

Click to show Reseller image

Order list endpoint:

Click to show Order image

Accumulated cashback endpoint:

Click to show Accumulated cashback image

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Giovani Moutinho - Linkedin

Project Link: https://github.com/mgiovani/reseller-cashback-api