linikerunk / Python-Challenge-Coodesh

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Marketplace

This is a repo about company, that will lead with several clientes and product that will have a commission.

Python version Code Style GitHub last commit License

Status: Progress

AboutFeaturesDemoRunning the projectRunning the test Tech StackHow to contributeAuthorLicense

💻 About

** AMcom ** - is a project that leads with API in DRF to communicate with a React aplications, to build a market-place and make querys for the user know about several things.


⚙️ Features

API Routes:

✔️ Route to register a new client. (It's called user within API and database)
✔️ [optional] Route to validate a reseller login and obtain a token.
✔️ Route to register a new product.
✔️ Route to launch products by date and time and quantity.
✔️ Route to consult salesperson data commission in a given period.

Technical resources:

✔️ [optional] Interactive documentation with (swagger)
✔️ Database PostgreSQL
✔️ Database Migrations
✔️ Micro-services with front-end with React to consume back-end


➡ UML

image

Deploys

The application is available on heroku and vercel:

UML about system:

🎃 Figma and Design the application

example register: image

Pre-requisites

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

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

🚀 Running the project

first you need to populate the database to initialize the table test

for this application you will need python version 3.8 +

1. Clone this repository:
 	`$ git clone https://github.com/linikerunk/amcom-market-place.git`
2. Create a virtualenv:
 	`$ python3 -m venv name_venv`
3. Activate your env (Linux):
 	`$ source name_venv/bin/activate`
3. Activate your env (Widowns):
 	`$ cd  name_venv/Scripts && ./activate`
4. Install the dependencies:
	`$ pip install -r requirements.txt`

Django up your server

cd backend
python manage.py migrate
python manage.py runserver

React start server

```sh cd frontend yarn yarn dev

running into 3333 port

---

## 🪓 Running the test
```sh
cd backend
python manage.py test tests\api
python manage.py test tests\models
python manage.py test tests\serializers
python manage.py test tests\services
# see if the tests is ok with coverage.
coverage run -m unittest

🛠 Tech Stack

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

Python + Django DRF

Dependences

💪 How to contribute

  1. Fork the project.
  2. Create a new branch with your changes: git checkout -b my-feature
  3. Save your changes and create a commit message telling you what you did: git commit -m" feature: My new feature "
  4. Submit your changes: git push origin my-feature

🦸‍♂️ Autor


Liniker Oliveira
🚀

[Linkedin Badge] Gmail Badge


📝 License

This project is under the license MIT.

About


Languages

Language:Python 100.0%