https://github.com/william1nguyen/ecoinbe

An e-commerce website that are selling coins using DRF, ReactJS
https://github.com/william1nguyen/ecoinbe

django django-rest-framework jwt-authentication reactjs stripe

Last synced: 5 days ago
JSON representation

An e-commerce website that are selling coins using DRF, ReactJS

• Host: GitHub
• URL: https://github.com/william1nguyen/ecoinbe
• Owner: william1nguyen
• Created: 2023-12-24T03:57:33.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-08-25T14:18:59.000Z (3 months ago)
• Last Synced: 2024-08-26T10:53:19.743Z (3 months ago)
• Topics: django, django-rest-framework, jwt-authentication, reactjs, stripe
• Language: Python
• Homepage: http://novahost.ecoin-nova.xyz/
• Size: 354 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ECOINBE

- This is backend for **Ecoin** ecommerce website.

- **Admin Site :** `Django` provide us a wonderful Admin Management Site.

- **Payment Method :** We are using `Stripe` (Stripe Elements) for virtualing a payment.

  - Region: We currently support `US` and `VN` using Stripe Address Elements.

  - Default Development Stripe Card:

    - `Card number`: 4242 4242 4242 4242

    - `Expiration`: 04/44

    - `CVC`: 444

### How to update/view Product/Order

- Open Admin Site

  ```

  python manage.py runserver

  ```

- Access `BASE_URL/admin`.

## Architecture & Relate Packages

- `Django Rest Framework`

- `ReactJs`

- `Bcrypt`

- `Stripe` **(for payment)**

  > [!WARNING]

  > React Alert: `react-hot-toast`

  > I use `ReacJS` for **Frontend**, so before deploying, **ReactJS** was exported.

- `Coverage & Django testing module` **(for testing)**: cover 81%.

## Requirements

- `Python ~ 3.12`

#### NOVA AI Assistant

- Bubble chat

![](https://github.com/william1nguyen/ecoinfe/raw/master/src/assets/new_features.png)

- Popup Apperance

![](https://github.com/william1nguyen/ecoinfe/raw/master/src/assets/bubblechat.png)

- ChatModel : Google Gemini

- Tools : (LLM Platform)Flowise, (Vector Database) Pinecone, ...

## Setup virtual env (Optional)

### Setup `Pipenv`

- See how to install [asdf](https://asdf-vm.com/guide/getting-started.html)

- Setup `pipenv`:

  ```

  $ pipenv shell

  ```

- Choose suitable version by modifying python version in Pipfile and run

  ```

  $ pipenv install

  ```

  > [!WARNING] > `pipenv` will create `Pipfile` and `Pipfile.lock` file in order to determine `python version` and packages used.

## Optional Setup Database

- In this project I use `db.sqlite3` thanks to it's easiness.

- You can use another like `MySQL, PostgresSQL, ...` by setting in `Settings.py`

  ```

  DATABASES = {

      "default": {

          "ENGINE": "django.db.backends.sqlite3",

          "NAME": BASE_DIR / "db.sqlite3",

      }

  }

  ```

  $\rightarrow$ Change `ENGINE` to other databases that are supported.

## How to run

### Local setup

- **Install packages**

  ```

  $ pipenv shell

  $ pipenv install

  ```

- **Configure Environment**

  Create a .env file from the provided .env.example and update the values accordingly.

  ```

  $ cp .env.example .env

  $ export $(grep -v '^#' .env | xargs)

  ```

- **Initialize models database with Django**

  ```

  $ python manage.py migrate

  ```

- **Run the Application**

  ```

  $ python manage.py runserver

  ```

- **Run tests after updating modules**

  ```

  $ coverage run manage.py test tests

  $ coverage report

  ```