https://github.com/ntut-xuan/fastshop

FastShop，一款以 React.js + Python Flask 為開發工具的輕量購物網站，滿足購買者與販賣者的需求
https://github.com/ntut-xuan/fastshop

Last synced: 21 days ago
JSON representation

FastShop，一款以 React.js + Python Flask 為開發工具的輕量購物網站，滿足購買者與販賣者的需求

• Host: GitHub
• URL: https://github.com/ntut-xuan/fastshop
• Owner: ntut-xuan
• License: mit
• Created: 2022-09-13T12:06:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T06:31:54.000Z (2 months ago)
• Last Synced: 2024-11-01T07:24:16.512Z (2 months ago)
• Language: Python
• Homepage:
• Size: 1.13 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FastShop

[![codecov](https://codecov.io/gh/ntut-xuan/FastShop/branch/main/graph/badge.svg?token=2LF2YOVAZA)](https://codecov.io/gh/ntut-xuan/FastShop)

![Unit Test](https://github.com/ntut-xuan/fastshop/actions/workflows/backend-unit-test.yml/badge.svg)

![Docker CI](https://github.com/ntut-xuan/fastshop/actions/workflows/docker-ci.yml/badge.svg)

## Introduction

![FastShop](https://user-images.githubusercontent.com/69747731/189900653-63525935-2691-487d-9709-1a030ff7c470.png)

FastShop，一款以 React.js + Python 為開發工具的輕量購物網站，滿足購買者與販賣者的需求。

## Repository root

```

*

|

| -- /src/              JSX files.

| -- /static/           Static files like JS files, images, and CSS. (frontend)

| -- /backend/          Backend files.

| -- /html/             HTML files.

| -- database.sql       SQL files to set up the database.

| -- babel.sh           The babel commands for compiling JSX files.

| -- tailwindcss.sh     The tailwindcss commands for generating CSS files to the static folder.

| -- Dockerfile         The environment setups in docker.

| -- docker-compose.yml The environment setups of multiple containers.

```

## Installation

The repository use docker to set up the environment.

Please use the following command to build the environment.

```bash

docker compose up

```

You can use the following command to force-rebuild the environment if any changes on Dockerfile are made.

But it will be set up more slowly.

```bash

docker compose up --build --force-recreate --no-deps

```

You can use VSCode-remote-plugin to connect the docker-container to the develop project.

## Contribution

Install the Git hook scripts with the following command.

```bash

pre-commit install

```